diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 5c4aa874..a89508ac 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -20,7 +20,6 @@ jobs: uses: ruby/setup-ruby@v1 with: bundler-cache: false - ruby-version: '3.1' - run: |- bundle install @@ -36,7 +35,6 @@ jobs: uses: ruby/setup-ruby@v1 with: bundler-cache: false - ruby-version: '3.1' - run: |- bundle install diff --git a/.github/workflows/publish-gem.yml b/.github/workflows/publish-gem.yml index 596266f1..476bfc7e 100644 --- a/.github/workflows/publish-gem.yml +++ b/.github/workflows/publish-gem.yml @@ -19,7 +19,6 @@ jobs: uses: ruby/setup-ruby@v1 with: bundler-cache: false - ruby-version: '3.1' - run: |- bundle install diff --git a/.release-please-manifest.json b/.release-please-manifest.json index 000572ec..b0699969 100644 --- a/.release-please-manifest.json +++ b/.release-please-manifest.json @@ -1,3 +1,3 @@ { - ".": "0.1.0-alpha.13" + ".": "0.1.0-alpha.14" } \ No newline at end of file diff --git a/.rubocop.yml b/.rubocop.yml index 1792ec63..b50fcd67 100644 --- a/.rubocop.yml +++ b/.rubocop.yml @@ -63,6 +63,8 @@ Layout/MultilineMethodParameterLineBreaks: # Prefer compact hash literals. Layout/SpaceInsideHashLiteralBraces: EnforcedStyle: no_space + Exclude: + - "**/*.rbi" Lint/BooleanSymbol: Enabled: false @@ -90,6 +92,10 @@ Lint/MissingSuper: Exclude: - "**/*.rbi" +Lint/SymbolConversion: + Exclude: + - "**/*.rbi" + # Disabled for safety reasons, this option changes code semantics. Lint/UnusedMethodArgument: AutoCorrect: false @@ -244,6 +250,10 @@ Style/RedundantInitialize: Exclude: - "**/*.rbi" +Style/RedundantParentheses: + Exclude: + - "**/*.rbi" + # Prefer slashes for regex literals. Style/RegexpLiteral: EnforcedStyle: slashes diff --git a/.ruby-version b/.ruby-version index fd2a0186..944880fa 100644 --- a/.ruby-version +++ b/.ruby-version @@ -1 +1 @@ -3.1.0 +3.2.0 diff --git a/.stats.yml b/.stats.yml index eae7b08e..ac3940f3 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 46 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/finch%2Ffinch-e5ab676f0996530fe4c702d8cbb88862ab8382792d01197a9576e06f5a359d00.yml -openapi_spec_hash: 5c0dec3d2e1fea26d5f99560b226aedd +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/finch%2Ffinch-f09e5f2c555d7ee764478b7bc73e92cd21f403d6ec189be14574c8367bc131ce.yml +openapi_spec_hash: bd0a8e001f14132c105992d40149909a config_hash: 53778a0b839c4f6ad34fbba051f5e8a6 diff --git a/CHANGELOG.md b/CHANGELOG.md index aef36bb3..8226d862 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,43 @@ # Changelog +## 0.1.0-alpha.14 (2025-05-07) + +Full Changelog: [v0.1.0-alpha.13...v0.1.0-alpha.14](https://github.com/Finch-API/finch-api-ruby/compare/v0.1.0-alpha.13...v0.1.0-alpha.14) + +### Features + +* **api:** api update ([a1e63ab](https://github.com/Finch-API/finch-api-ruby/commit/a1e63ab1e953ca1a3745ec158e5cbba3336e8cc4)) +* **api:** api update ([131b860](https://github.com/Finch-API/finch-api-ruby/commit/131b8600623807e6f9fe61eec0008f466ea9bf51)) +* **api:** api update ([0cb263a](https://github.com/Finch-API/finch-api-ruby/commit/0cb263a792ddcd544d4b790dcb87a49af23798de)) +* **api:** api update ([664ac2e](https://github.com/Finch-API/finch-api-ruby/commit/664ac2e40a5f79294e19f2536241e3e3080b35bd)) +* **api:** api update ([f4d4ab0](https://github.com/Finch-API/finch-api-ruby/commit/f4d4ab0dcfb81d75e0f7fe5bee9583a616e39ac6)) +* **api:** api update ([bdab477](https://github.com/Finch-API/finch-api-ruby/commit/bdab47770cdc398d71349734d214d365569311a0)) + + +### Bug Fixes + +* **internal:** ensure formatting always uses c.utf-8 locale ([4b68a42](https://github.com/Finch-API/finch-api-ruby/commit/4b68a42729fba915f1d778b306f9a1120f936012)) +* **internal:** fix formatting script for macos ([549b415](https://github.com/Finch-API/finch-api-ruby/commit/549b415b8fbb8baf6de342de32798d3096085a3c)) + + +### Chores + +* accept all nd-json mimetype variants ([53a8863](https://github.com/Finch-API/finch-api-ruby/commit/53a8863036254bd052c47fb283c82798784859f6)) +* always check if current page is empty in `next_page?` ([89f7522](https://github.com/Finch-API/finch-api-ruby/commit/89f7522c76cbf4cb79a171b842fdb9db8ca0fb1f)) +* **internal:** codegen related update ([15d107c](https://github.com/Finch-API/finch-api-ruby/commit/15d107cee7ff974a750f1cbfa812392ac1b7fc47)) +* **internal:** codegen related update ([bcaecfa](https://github.com/Finch-API/finch-api-ruby/commit/bcaecfa4b137a6a767d69ea15c77885185d8368c)) +* **internal:** codegen related update ([f328b3a](https://github.com/Finch-API/finch-api-ruby/commit/f328b3a5c3ea6ffeb01186ea929b4eb6f70ef1aa)) +* re-export top level models under library namespace ([e8cc430](https://github.com/Finch-API/finch-api-ruby/commit/e8cc430134d053ce8e3e5d31aea2c43270eb2ffa)) +* remove Gemfile.lock during bootstrap ([6a383f0](https://github.com/Finch-API/finch-api-ruby/commit/6a383f0228803c29f1a22658821311ad3239aa97)) +* reorganize type aliases ([e527e5d](https://github.com/Finch-API/finch-api-ruby/commit/e527e5d5d118f2d00611a2f790e9fcc67a4794b0)) +* revert ignoring Gemfile.lock ([8abcd39](https://github.com/Finch-API/finch-api-ruby/commit/8abcd39a9a0ba36ac5e1a8b65e69762c174408e4)) +* validate request option coercion correctness ([41e068d](https://github.com/Finch-API/finch-api-ruby/commit/41e068d7304cd25e4e250a2c724cb99b1bf9d9b8)) + + +### Documentation + +* **readme:** fix typo ([15960ca](https://github.com/Finch-API/finch-api-ruby/commit/15960caf4fd7cfd3596326a0605ab61a64441558)) + ## 0.1.0-alpha.13 (2025-04-29) Full Changelog: [v0.1.0-alpha.12...v0.1.0-alpha.13](https://github.com/Finch-API/finch-api-ruby/compare/v0.1.0-alpha.12...v0.1.0-alpha.13) diff --git a/Gemfile.lock b/Gemfile.lock index fe5156a2..52ab1b15 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -1,6 +1,6 @@ GIT remote: https://github.com/stainless-api/syntax_tree-rbs.git - revision: 140eb3ba2ff4b959b345ac2a7927cd758a9f1284 + revision: c30b50219918be7cfe3ef803a00b59d1e77fcada branch: main specs: syntax_tree-rbs (1.0.0) @@ -11,13 +11,13 @@ GIT PATH remote: . specs: - finch-api (0.1.0.pre.alpha.12) + finch-api (0.1.0.pre.alpha.13) connection_pool GEM remote: https://rubygems.org/ specs: - activesupport (7.2.2.1) + activesupport (8.0.2) base64 benchmark (>= 0.3) bigdecimal @@ -29,10 +29,11 @@ GEM minitest (>= 5.1) securerandom (>= 0.3) tzinfo (~> 2.0, >= 2.0.5) + uri (>= 0.13.1) addressable (2.8.7) public_suffix (>= 2.0.2, < 7.0) ast (2.4.3) - async (2.23.1) + async (2.24.0) console (~> 1.29) fiber-annotation io-event (~> 1.9) @@ -42,7 +43,7 @@ GEM benchmark (0.4.0) bigdecimal (3.1.9) concurrent-ruby (1.3.5) - connection_pool (2.5.0) + connection_pool (2.5.3) console (1.30.2) fiber-annotation fiber-local (~> 1.1) @@ -50,20 +51,20 @@ GEM crack (1.0.0) bigdecimal rexml - csv (3.3.3) + csv (3.3.4) drb (2.2.1) erubi (1.13.1) - ffi (1.17.1) + ffi (1.17.2-x86_64-linux-gnu) fiber-annotation (0.2.0) fiber-local (1.1.0) fiber-storage - fiber-storage (1.0.0) + fiber-storage (1.0.1) fileutils (1.7.3) hashdiff (1.1.2) i18n (1.14.7) concurrent-ruby (~> 1.0) io-event (1.10.0) - json (2.10.2) + json (2.11.3) language_server-protocol (3.17.0.4) lint_roller (1.1.0) listen (3.9.0) @@ -82,20 +83,20 @@ GEM minitest (~> 5.0) mutex_m (0.3.0) netrc (0.11.0) - parallel (1.26.3) - parser (3.3.7.4) + parallel (1.27.0) + parser (3.3.8.0) ast (~> 2.4.1) racc prettier_print (1.2.1) prism (1.4.0) - public_suffix (6.0.1) + public_suffix (6.0.2) racc (1.8.1) rainbow (3.1.1) rake (13.2.1) rb-fsevent (0.11.2) rb-inotify (0.11.1) ffi (~> 1.0) - rbi (0.3.1) + rbi (0.3.2) prism (~> 1.0) rbs (>= 3.4.4) sorbet-runtime (>= 0.5.9204) @@ -104,7 +105,7 @@ GEM redcarpet (3.6.1) regexp_parser (2.10.0) rexml (3.4.1) - rubocop (1.75.1) + rubocop (1.75.5) json (~> 2.3) language_server-protocol (~> 3.17.0.2) lint_roller (~> 1.1.0) @@ -112,21 +113,21 @@ GEM parser (>= 3.3.0.2) rainbow (>= 2.2.2, < 4.0) regexp_parser (>= 2.9.3, < 3.0) - rubocop-ast (>= 1.43.0, < 2.0) + rubocop-ast (>= 1.44.0, < 2.0) ruby-progressbar (~> 1.7) unicode-display_width (>= 2.4.0, < 4.0) - rubocop-ast (1.43.0) + rubocop-ast (1.44.1) parser (>= 3.3.7.2) prism (~> 1.4) ruby-progressbar (1.13.0) securerandom (0.4.1) - sorbet (0.5.11966) - sorbet-static (= 0.5.11966) - sorbet-runtime (0.5.11966) - sorbet-static (0.5.11966-x86_64-linux) - sorbet-static-and-runtime (0.5.11966) - sorbet (= 0.5.11966) - sorbet-runtime (= 0.5.11966) + sorbet (0.5.12067) + sorbet-static (= 0.5.12067) + sorbet-runtime (0.5.12067) + sorbet-static (0.5.12067-x86_64-linux) + sorbet-static-and-runtime (0.5.12067) + sorbet (= 0.5.12067) + sorbet-runtime (= 0.5.12067) spoom (1.6.1) erubi (>= 1.10.0) prism (>= 0.28.0) @@ -150,7 +151,7 @@ GEM strscan (>= 1.0.0) terminal-table (>= 2, < 5) uri (>= 0.12.0) - strscan (3.1.2) + strscan (3.1.5) syntax_tree (6.2.0) prettier_print (>= 1.2.0) tapioca (0.16.11) @@ -208,4 +209,4 @@ DEPENDENCIES yard BUNDLED WITH - 2.3.3 + 2.4.1 diff --git a/README.md b/README.md index f2893ac1..54cfa4b4 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Finch Ruby API library -The Finch Ruby library provides convenient access to the Finch REST API from any Ruby 3.1.0+ application. +The Finch Ruby library provides convenient access to the Finch REST API from any Ruby 3.2.0+ application. It is generated with [Stainless](https://www.stainless.com/). @@ -17,7 +17,7 @@ To use this gem, install via Bundler by adding the following to your application ```ruby -gem "finch-api", "~> 0.1.0.pre.alpha.13" +gem "finch-api", "~> 0.1.0.pre.alpha.14" ``` @@ -76,7 +76,7 @@ rescue FinchAPI::Errors::APIError => e end ``` -Error codes are as followed: +Error codes are as follows: | Cause | Error Type | | ---------------- | -------------------------- | @@ -191,9 +191,9 @@ Sorbet's typed enums require sub-classing of the [`T::Enum` class](https://sorbe Since this library does not depend on `sorbet-runtime`, it uses a [`T.all` intersection type](https://sorbet.org/docs/intersection-types) with a ruby primitive type to construct a "tagged alias" instead. ```ruby -module FinchAPI::Models::ConnectionStatusType +module FinchAPI::ConnectionStatusType # This alias aids language service driven navigation. - TaggedSymbol = T.type_alias { T.all(Symbol, FinchAPI::Models::ConnectionStatusType) } + TaggedSymbol = T.type_alias { T.all(Symbol, FinchAPI::ConnectionStatusType) } end ``` @@ -214,7 +214,7 @@ This package considers improvements to the (non-runtime) `*.rbi` and `*.rbs` typ ## Requirements -Ruby 3.1.0 or higher. +Ruby 3.2.0 or higher. ## Contributing diff --git a/Rakefile b/Rakefile index 97b1805c..8361a8b9 100644 --- a/Rakefile +++ b/Rakefile @@ -31,14 +31,16 @@ multitask(:test) do .map { "require_relative(#{_1.dump});" } .join - ruby(*%w[-e], rb, verbose: false) { fail unless _1 } + ruby(*%w[-w -e], rb, verbose: false) { fail unless _1 } end -rubo_find = %w[find ./lib ./test ./rbi -type f -and ( -name *.rb -or -name *.rbi ) -print0] xargs = %w[xargs --no-run-if-empty --null --max-procs=0 --max-args=300 --] +locale = {"LC_ALL" => "C.UTF-8"} desc("Lint `*.rb(i)`") multitask(:"lint:rubocop") do + find = %w[find ./lib ./test ./rbi -type f -and ( -name *.rb -or -name *.rbi ) -print0] + rubocop = %w[rubocop --fail-level E] rubocop += %w[--format github] if ENV.key?("CI") @@ -46,24 +48,34 @@ multitask(:"lint:rubocop") do rubocop += %w[--except Lint/RedundantCopDisableDirective,Layout/LineLength] lint = xargs + rubocop - sh("#{rubo_find.shelljoin} | #{lint.shelljoin}") + sh("#{find.shelljoin} | #{lint.shelljoin}") end -desc("Format `*.rb(i)`") -multitask(:"format:rubocop") do +desc("Format `*.rb`") +multitask(:"format:rb") do + # while `syntax_tree` is much faster than `rubocop`, `rubocop` is the only formatter with full syntax support + find = %w[find ./lib ./test -type f -and -name *.rb -print0] fmt = xargs + %w[rubocop --fail-level F --autocorrect --format simple --] - sh("#{rubo_find.shelljoin} | #{fmt.shelljoin}") + sh("#{find.shelljoin} | #{fmt.shelljoin}") +end + +desc("Format `*.rbi`") +multitask(:"format:rbi") do + find = %w[find ./rbi -type f -and -name *.rbi -print0] + fmt = xargs + %w[stree write --] + sh(locale, "#{find.shelljoin} | #{fmt.shelljoin}") end desc("Format `*.rbs`") -multitask(:"format:syntax_tree") do +multitask(:"format:rbs") do find = %w[find ./sig -type f -name *.rbs -print0] - inplace = /darwin|bsd/ =~ RUBY_PLATFORM ? %w[-i''] : %w[-i] + inplace = /darwin|bsd/ =~ RUBY_PLATFORM ? ["-i", ""] : %w[-i] uuid = SecureRandom.uuid # `syntax_tree` has trouble with `rbs`'s class & module aliases - sed = xargs + %w[sed -E] + inplace + %w[-e] + sed_bin = /darwin/ =~ RUBY_PLATFORM ? "/usr/bin/sed" : "sed" + sed = xargs + [sed_bin, "-E", *inplace, "-e"] # annotate unprocessable aliases with a unique comment pre = sed + ["s/(class|module) ([^ ]+) = (.+$)/# \\1 #{uuid}\\n\\2: \\3/", "--"] fmt = xargs + %w[stree write --plugin=rbs --] @@ -87,7 +99,7 @@ multitask(:"format:syntax_tree") do # transform class aliases to type aliases, which syntax tree has no trouble with sh("#{find.shelljoin} | #{pre.shelljoin}") # run syntax tree to format `*.rbs` files - sh("#{find.shelljoin} | #{fmt.shelljoin}") do + sh(locale, "#{find.shelljoin} | #{fmt.shelljoin}") do success = _1 end # transform type aliases back to class aliases @@ -98,7 +110,7 @@ multitask(:"format:syntax_tree") do end desc("Format everything") -multitask(format: [:"format:rubocop", :"format:syntax_tree"]) +multitask(format: [:"format:rb", :"format:rbi", :"format:rbs"]) desc("Typecheck `*.rbs`") multitask(:"typecheck:steep") do diff --git a/finch_api.gemspec b/finch_api.gemspec index b06d861a..bfcb4534 100644 --- a/finch_api.gemspec +++ b/finch_api.gemspec @@ -12,7 +12,7 @@ Gem::Specification.new do |s| 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.to_s - s.required_ruby_version = ">= 3.0.0" + s.required_ruby_version = ">= 3.2.0" s.files = Dir[ "lib/**/*.rb", diff --git a/lib/finch_api.rb b/lib/finch_api.rb index a59edacb..d5161c9f 100644 --- a/lib/finch_api.rb +++ b/lib/finch_api.rb @@ -174,6 +174,7 @@ require_relative "finch_api/models/sandbox/payment_create_params" require_relative "finch_api/models/sandbox/payment_create_response" require_relative "finch_api/models/webhook_event" +require_relative "finch_api/models" require_relative "finch_api/resources/access_tokens" require_relative "finch_api/resources/account" require_relative "finch_api/resources/connect" diff --git a/lib/finch_api/file_part.rb b/lib/finch_api/file_part.rb index f1e820a7..0fd397f2 100644 --- a/lib/finch_api/file_part.rb +++ b/lib/finch_api/file_part.rb @@ -45,9 +45,9 @@ def initialize(content, filename: nil, content_type: nil) @filename = case content in Pathname - filename.nil? ? content.basename.to_path : File.basename(filename) + filename.nil? ? content.basename.to_path : ::File.basename(filename) else - filename.nil? ? nil : File.basename(filename) + filename.nil? ? nil : ::File.basename(filename) end @content_type = content_type end diff --git a/lib/finch_api/internal/individuals_page.rb b/lib/finch_api/internal/individuals_page.rb index fdf139ae..c6dbf9e8 100644 --- a/lib/finch_api/internal/individuals_page.rb +++ b/lib/finch_api/internal/individuals_page.rb @@ -19,12 +19,12 @@ class IndividualsPage # @return [Array>, nil] attr_accessor :individuals - # @return [FinchAPI::Models::Paging] + # @return [FinchAPI::Paging] attr_accessor :paging # @return [Boolean] def next_page? - paging&.offset.to_i + individuals.to_a.size < paging&.count.to_i + !individuals.to_a.empty? && (paging&.offset.to_i + individuals.to_a.size < paging&.count.to_i) end # @raise [FinchAPI::HTTP::Error] @@ -69,13 +69,13 @@ def initialize(client:, req:, headers:, page_data:) super case page_data - in {individuals: Array | nil => individuals} - @individuals = individuals&.map { FinchAPI::Internal::Type::Converter.coerce(@model, _1) } + in {individuals: Array => individuals} + @individuals = individuals.map { FinchAPI::Internal::Type::Converter.coerce(@model, _1) } else end case page_data in {paging: Hash | nil => paging} - @paging = FinchAPI::Internal::Type::Converter.coerce(FinchAPI::Models::Paging, paging) + @paging = FinchAPI::Internal::Type::Converter.coerce(FinchAPI::Paging, paging) else end end diff --git a/lib/finch_api/internal/page.rb b/lib/finch_api/internal/page.rb index 6f8c93e8..d820d555 100644 --- a/lib/finch_api/internal/page.rb +++ b/lib/finch_api/internal/page.rb @@ -19,12 +19,12 @@ class Page # @return [Array>, nil] attr_accessor :data - # @return [FinchAPI::Models::Paging] + # @return [FinchAPI::Paging] attr_accessor :paging # @return [Boolean] def next_page? - paging&.offset.to_i + data.to_a.size < paging&.count.to_i + !data.to_a.empty? && (paging&.offset.to_i + data.to_a.size < paging&.count.to_i) end # @raise [FinchAPI::HTTP::Error] @@ -69,13 +69,13 @@ def initialize(client:, req:, headers:, page_data:) super case page_data - in {data: Array | nil => data} - @data = data&.map { FinchAPI::Internal::Type::Converter.coerce(@model, _1) } + in {data: Array => data} + @data = data.map { FinchAPI::Internal::Type::Converter.coerce(@model, _1) } else end case page_data in {paging: Hash | nil => paging} - @paging = FinchAPI::Internal::Type::Converter.coerce(FinchAPI::Models::Paging, paging) + @paging = FinchAPI::Internal::Type::Converter.coerce(FinchAPI::Paging, paging) else end end diff --git a/lib/finch_api/internal/responses_page.rb b/lib/finch_api/internal/responses_page.rb index f8bf734e..00dc07b0 100644 --- a/lib/finch_api/internal/responses_page.rb +++ b/lib/finch_api/internal/responses_page.rb @@ -57,8 +57,8 @@ def initialize(client:, req:, headers:, page_data:) super case page_data - in {responses: Array | nil => responses} - @responses = responses&.map { FinchAPI::Internal::Type::Converter.coerce(@model, _1) } + in {responses: Array => responses} + @responses = responses.map { FinchAPI::Internal::Type::Converter.coerce(@model, _1) } else end end diff --git a/lib/finch_api/internal/transport/base_client.rb b/lib/finch_api/internal/transport/base_client.rb index a5a9fa69..8b715cfa 100644 --- a/lib/finch_api/internal/transport/base_client.rb +++ b/lib/finch_api/internal/transport/base_client.rb @@ -261,7 +261,7 @@ def initialize( headers["x-stainless-retry-count"] = "0" end - timeout = opts.fetch(:timeout, @timeout).to_f.clamp((0..)) + timeout = opts.fetch(:timeout, @timeout).to_f.clamp(0..) unless headers.key?("x-stainless-timeout") || timeout.zero? headers["x-stainless-timeout"] = timeout.to_s end @@ -458,9 +458,9 @@ def request(req) decoded = FinchAPI::Internal::Util.decode_content(response, stream: stream) case req - in { stream: Class => st } + in {stream: Class => st} st.new(model: model, url: url, status: status, response: response, stream: decoded) - in { page: Class => page } + in {page: Class => page} page.new(client: self, req: req, headers: response, page_data: decoded) else unwrapped = FinchAPI::Internal::Util.dig(decoded, req[:unwrap]) diff --git a/lib/finch_api/internal/type/base_model.rb b/lib/finch_api/internal/type/base_model.rb index 6282ca6f..66b9e378 100644 --- a/lib/finch_api/internal/type/base_model.rb +++ b/lib/finch_api/internal/type/base_model.rb @@ -397,15 +397,7 @@ def to_yaml(*a) = FinchAPI::Internal::Type::Converter.dump(self.class, self).to_ # Create a new instance of a model. # # @param data [Hash{Symbol=>Object}, self] - def initialize(data = {}) - case FinchAPI::Internal::Util.coerce_hash(data) - in Hash => coerced - @data = coerced - else - message = "Expected a #{Hash} or #{FinchAPI::Internal::Type::BaseModel}, got #{data.inspect}" - raise ArgumentError.new(message) - end - end + def initialize(data = {}) = (@data = FinchAPI::Internal::Util.coerce_hash!(data).to_h) class << self # @api private diff --git a/lib/finch_api/internal/type/enum.rb b/lib/finch_api/internal/type/enum.rb index 56ec82e2..830a9ad6 100644 --- a/lib/finch_api/internal/type/enum.rb +++ b/lib/finch_api/internal/type/enum.rb @@ -17,13 +17,13 @@ module Type # values safely. # # @example - # # `connection_status_type` is a `FinchAPI::Models::ConnectionStatusType` + # # `connection_status_type` is a `FinchAPI::ConnectionStatusType` # case connection_status_type - # when FinchAPI::Models::ConnectionStatusType::PENDING + # when FinchAPI::ConnectionStatusType::PENDING # # ... - # when FinchAPI::Models::ConnectionStatusType::PROCESSING + # when FinchAPI::ConnectionStatusType::PROCESSING # # ... - # when FinchAPI::Models::ConnectionStatusType::CONNECTED + # when FinchAPI::ConnectionStatusType::CONNECTED # # ... # else # puts(connection_status_type) diff --git a/lib/finch_api/internal/type/request_parameters.rb b/lib/finch_api/internal/type/request_parameters.rb index a1b81ba6..7c886fce 100644 --- a/lib/finch_api/internal/type/request_parameters.rb +++ b/lib/finch_api/internal/type/request_parameters.rb @@ -5,10 +5,10 @@ module Internal module Type # @api private module RequestParameters - # @!parse - # # Options to specify HTTP behaviour for this request. - # # @return [FinchAPI::RequestOptions, Hash{Symbol=>Object}] - # attr_accessor :request_options + # @!attribute request_options + # Options to specify HTTP behaviour for this request. + # + # @return [FinchAPI::RequestOptions, Hash{Symbol=>Object}] # @param mod [Module] def self.included(mod) @@ -28,14 +28,8 @@ def dump_request(params) state = {can_retry: true} case (dumped = dump(params, state: state)) in Hash - options = FinchAPI::Internal::Util.coerce_hash(dumped[:request_options]) - request_options = - case [options, state.fetch(:can_retry)] - in [Hash | nil, false] - {**options.to_h, max_retries: 0} - else - options - end + options = FinchAPI::Internal::Util.coerce_hash!(dumped[:request_options]).to_h + request_options = state.fetch(:can_retry) ? options : {**options, max_retries: 0} [dumped.except(:request_options), request_options] else [dumped, nil] diff --git a/lib/finch_api/internal/type/union.rb b/lib/finch_api/internal/type/union.rb index 152aaa3e..2a39afe8 100644 --- a/lib/finch_api/internal/type/union.rb +++ b/lib/finch_api/internal/type/union.rb @@ -8,9 +8,9 @@ module Type # @example # # `document_retreive_response` is a `FinchAPI::Models::HRIS::DocumentRetreiveResponse` # case document_retreive_response - # when FinchAPI::Models::HRIS::W42020 + # when FinchAPI::HRIS::W42020 # puts(document_retreive_response.data) - # when FinchAPI::Models::HRIS::W42005 + # when FinchAPI::HRIS::W42005 # puts(document_retreive_response.type) # else # puts(document_retreive_response) diff --git a/lib/finch_api/internal/util.rb b/lib/finch_api/internal/util.rb index 7004da5c..0e621b04 100644 --- a/lib/finch_api/internal/util.rb +++ b/lib/finch_api/internal/util.rb @@ -128,6 +128,22 @@ def coerce_hash(input) input.respond_to?(:to_h) ? input.to_h : input end end + + # @api private + # + # @param input [Object] + # + # @raise [ArgumentError] + # @return [Hash{Object=>Object}, nil] + def coerce_hash!(input) + case coerce_hash(input) + in Hash | nil => coerced + coerced + else + message = "Expected a #{Hash} or #{FinchAPI::Internal::Type::BaseModel}, got #{data.inspect}" + raise ArgumentError.new(message) + end + end end class << self @@ -454,7 +470,7 @@ def writable_enum(&blk) # @type [Regexp] JSON_CONTENT = %r{^application/(?:vnd(?:\.[^.]+)*\+)?json(?!l)} # @type [Regexp] - JSONL_CONTENT = %r{^application/(?:x-)?jsonl} + JSONL_CONTENT = %r{^application/(:?x-(?:n|l)djson)|(:?(?:x-)?jsonl)} class << self # @api private @@ -493,7 +509,7 @@ class << self y << val.to_s else y << "Content-Type: application/json\r\n\r\n" - y << JSON.fast_generate(val) + y << JSON.generate(val) end y << "\r\n" end @@ -519,7 +535,7 @@ class << self filename = ERB::Util.url_encode(val.filename) y << "; filename=\"#{filename}\"" in Pathname | IO - filename = ERB::Util.url_encode(File.basename(val.to_path)) + filename = ERB::Util.url_encode(::File.basename(val.to_path)) y << "; filename=\"#{filename}\"" else end @@ -570,9 +586,9 @@ def encode_content(headers, body) content_type = headers["content-type"] case [content_type, body] in [FinchAPI::Internal::Util::JSON_CONTENT, Hash | Array | -> { primitive?(_1) }] - [headers, JSON.fast_generate(body)] + [headers, JSON.generate(body)] in [FinchAPI::Internal::Util::JSONL_CONTENT, Enumerable] unless body.is_a?(FinchAPI::Internal::Type::FileInput) - [headers, body.lazy.map { JSON.fast_generate(_1) }] + [headers, body.lazy.map { JSON.generate(_1) }] in [%r{^multipart/form-data}, Hash | FinchAPI::Internal::Type::FileInput] boundary, strio = encode_multipart_streaming(body) headers = {**headers, "content-type" => "#{content_type}; boundary=#{boundary}"} diff --git a/lib/finch_api/models.rb b/lib/finch_api/models.rb new file mode 100644 index 00000000..24688159 --- /dev/null +++ b/lib/finch_api/models.rb @@ -0,0 +1,65 @@ +# frozen_string_literal: true + +module FinchAPI + AccessTokenCreateParams = FinchAPI::Models::AccessTokenCreateParams + + AccountDisconnectParams = FinchAPI::Models::AccountDisconnectParams + + AccountIntrospectParams = FinchAPI::Models::AccountIntrospectParams + + AccountUpdateEvent = FinchAPI::Models::AccountUpdateEvent + + BaseWebhookEvent = FinchAPI::Models::BaseWebhookEvent + + CompanyEvent = FinchAPI::Models::CompanyEvent + + Connect = FinchAPI::Models::Connect + + ConnectionStatusType = FinchAPI::Models::ConnectionStatusType + + CreateAccessTokenResponse = FinchAPI::Models::CreateAccessTokenResponse + + DirectoryEvent = FinchAPI::Models::DirectoryEvent + + DisconnectResponse = FinchAPI::Models::DisconnectResponse + + EmploymentEvent = FinchAPI::Models::EmploymentEvent + + HRIS = FinchAPI::Models::HRIS + + Income = FinchAPI::Models::Income + + IndividualEvent = FinchAPI::Models::IndividualEvent + + Introspection = FinchAPI::Models::Introspection + + JobCompletionEvent = FinchAPI::Models::JobCompletionEvent + + Jobs = FinchAPI::Models::Jobs + + Location = FinchAPI::Models::Location + + Money = FinchAPI::Models::Money + + OperationSupport = FinchAPI::Models::OperationSupport + + OperationSupportMatrix = FinchAPI::Models::OperationSupportMatrix + + Paging = FinchAPI::Models::Paging + + PaymentEvent = FinchAPI::Models::PaymentEvent + + Payroll = FinchAPI::Models::Payroll + + PayStatementEvent = FinchAPI::Models::PayStatementEvent + + Provider = FinchAPI::Models::Provider + + ProviderListParams = FinchAPI::Models::ProviderListParams + + RequestForwardingForwardParams = FinchAPI::Models::RequestForwardingForwardParams + + Sandbox = FinchAPI::Models::Sandbox + + WebhookEvent = FinchAPI::Models::WebhookEvent +end diff --git a/lib/finch_api/models/account_update_event.rb b/lib/finch_api/models/account_update_event.rb index 09ce7f6b..a828bb45 100644 --- a/lib/finch_api/models/account_update_event.rb +++ b/lib/finch_api/models/account_update_event.rb @@ -5,124 +5,132 @@ module Models class AccountUpdateEvent < FinchAPI::Models::BaseWebhookEvent # @!attribute data # - # @return [FinchAPI::Models::AccountUpdateEvent::Data, nil] - optional :data, -> { FinchAPI::Models::AccountUpdateEvent::Data } + # @return [FinchAPI::AccountUpdateEvent::Data, nil] + optional :data, -> { FinchAPI::AccountUpdateEvent::Data } # @!attribute event_type # - # @return [Symbol, FinchAPI::Models::AccountUpdateEvent::EventType, nil] - optional :event_type, enum: -> { FinchAPI::Models::AccountUpdateEvent::EventType } + # @return [Symbol, FinchAPI::AccountUpdateEvent::EventType, nil] + optional :event_type, enum: -> { FinchAPI::AccountUpdateEvent::EventType } # @!method initialize(data: nil, event_type: nil) - # @param data [FinchAPI::Models::AccountUpdateEvent::Data] - # @param event_type [Symbol, FinchAPI::Models::AccountUpdateEvent::EventType] + # @param data [FinchAPI::AccountUpdateEvent::Data] + # @param event_type [Symbol, FinchAPI::AccountUpdateEvent::EventType] class Data < FinchAPI::Internal::Type::BaseModel # @!attribute authentication_method # - # @return [FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod] - required :authentication_method, -> { FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod } + # @return [FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod] + required :authentication_method, -> { FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod } # @!attribute status # - # @return [Symbol, FinchAPI::Models::ConnectionStatusType] - required :status, enum: -> { FinchAPI::Models::ConnectionStatusType } + # @return [Symbol, FinchAPI::ConnectionStatusType] + required :status, enum: -> { FinchAPI::ConnectionStatusType } # @!method initialize(authentication_method:, status:) - # @param authentication_method [FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod] - # @param status [Symbol, FinchAPI::Models::ConnectionStatusType] + # @param authentication_method [FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod] + # @param status [Symbol, FinchAPI::ConnectionStatusType] - # @see FinchAPI::Models::AccountUpdateEvent::Data#authentication_method + # @see FinchAPI::AccountUpdateEvent::Data#authentication_method class AuthenticationMethod < FinchAPI::Internal::Type::BaseModel # @!attribute benefits_support # Each benefit type and their supported features. If the benefit type is not # supported, the property will be null # - # @return [FinchAPI::Models::HRIS::BenefitsSupport, nil] - optional :benefits_support, -> { FinchAPI::Models::HRIS::BenefitsSupport }, nil?: true + # @return [FinchAPI::HRIS::BenefitsSupport, nil] + optional :benefits_support, -> { FinchAPI::HRIS::BenefitsSupport }, nil?: true # @!attribute supported_fields # The supported data fields returned by our HR and payroll endpoints # - # @return [FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields, nil] + # @return [FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields, nil] optional :supported_fields, - -> { FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields }, + -> { FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields }, nil?: true # @!attribute type # The type of authentication method. # - # @return [Symbol, FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::Type, nil] - optional :type, enum: -> { FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::Type } + # @return [Symbol, FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::Type, nil] + optional :type, enum: -> { FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::Type } # @!method initialize(benefits_support: nil, supported_fields: nil, type: nil) # Some parameter documentations has been truncated, see - # {FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod} for more - # details. + # {FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod} for more details. # - # @param benefits_support [FinchAPI::Models::HRIS::BenefitsSupport, nil] Each benefit type and their supported features. If the benefit type is not suppo - # ... + # @param benefits_support [FinchAPI::HRIS::BenefitsSupport, nil] Each benefit type and their supported features. If the benefit type is not suppo # - # @param supported_fields [FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields, nil] The supported data fields returned by our HR and payroll endpoints + # @param supported_fields [FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields, nil] The supported data fields returned by our HR and payroll endpoints # - # @param type [Symbol, FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::Type] The type of authentication method. + # @param type [Symbol, FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::Type] The type of authentication method. - # @see FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod#supported_fields + # @see FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod#supported_fields class SupportedFields < FinchAPI::Internal::Type::BaseModel # @!attribute company # - # @return [FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company, nil] + # @return [FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company, nil] optional :company, - -> { FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company } + -> { FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company } # @!attribute directory # - # @return [FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory, nil] + # @return [FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory, nil] optional :directory, - -> { FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory } + -> { + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory + } # @!attribute employment # - # @return [FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment, nil] + # @return [FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment, nil] optional :employment, - -> { FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment } + -> { + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment + } # @!attribute individual # - # @return [FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual, nil] + # @return [FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual, nil] optional :individual, - -> { FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual } + -> { + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual + } # @!attribute pay_group # - # @return [FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayGroup, nil] + # @return [FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayGroup, nil] optional :pay_group, - -> { FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayGroup } + -> { + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayGroup + } # @!attribute pay_statement # - # @return [FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement, nil] + # @return [FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement, nil] optional :pay_statement, - -> { FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement } + -> { + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement + } # @!attribute payment # - # @return [FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Payment, nil] + # @return [FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Payment, nil] optional :payment, - -> { FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Payment } + -> { FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Payment } # @!method initialize(company: nil, directory: nil, employment: nil, individual: nil, pay_group: nil, pay_statement: nil, payment: nil) # The supported data fields returned by our HR and payroll endpoints # - # @param company [FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company] - # @param directory [FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory] - # @param employment [FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment] - # @param individual [FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual] - # @param pay_group [FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayGroup] - # @param pay_statement [FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement] - # @param payment [FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Payment] - - # @see FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields#company + # @param company [FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company] + # @param directory [FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory] + # @param employment [FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment] + # @param individual [FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual] + # @param pay_group [FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayGroup] + # @param pay_statement [FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement] + # @param payment [FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Payment] + + # @see FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields#company class Company < FinchAPI::Internal::Type::BaseModel # @!attribute id # @@ -131,15 +139,19 @@ class Company < FinchAPI::Internal::Type::BaseModel # @!attribute accounts # - # @return [FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Accounts, nil] + # @return [FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Accounts, nil] optional :accounts, - -> { FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Accounts } + -> { + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Accounts + } # @!attribute departments # - # @return [FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Departments, nil] + # @return [FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Departments, nil] optional :departments, - -> { FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Departments } + -> { + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Departments + } # @!attribute ein # @@ -148,9 +160,11 @@ class Company < FinchAPI::Internal::Type::BaseModel # @!attribute entity # - # @return [FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Entity, nil] + # @return [FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Entity, nil] optional :entity, - -> { FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Entity } + -> { + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Entity + } # @!attribute legal_name # @@ -159,9 +173,11 @@ class Company < FinchAPI::Internal::Type::BaseModel # @!attribute locations # - # @return [FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Locations, nil] + # @return [FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Locations, nil] optional :locations, - -> { FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Locations } + -> { + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Locations + } # @!attribute primary_email # @@ -175,16 +191,16 @@ class Company < FinchAPI::Internal::Type::BaseModel # @!method initialize(id: nil, accounts: nil, departments: nil, ein: nil, entity: nil, legal_name: nil, locations: nil, primary_email: nil, primary_phone_number: nil) # @param id [Boolean] - # @param accounts [FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Accounts] - # @param departments [FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Departments] + # @param accounts [FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Accounts] + # @param departments [FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Departments] # @param ein [Boolean] - # @param entity [FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Entity] + # @param entity [FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Entity] # @param legal_name [Boolean] - # @param locations [FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Locations] + # @param locations [FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Locations] # @param primary_email [Boolean] # @param primary_phone_number [Boolean] - # @see FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company#accounts + # @see FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company#accounts class Accounts < FinchAPI::Internal::Type::BaseModel # @!attribute account_name # @@ -219,7 +235,7 @@ class Accounts < FinchAPI::Internal::Type::BaseModel # @param routing_number [Boolean] end - # @see FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company#departments + # @see FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company#departments class Departments < FinchAPI::Internal::Type::BaseModel # @!attribute name # @@ -228,15 +244,17 @@ class Departments < FinchAPI::Internal::Type::BaseModel # @!attribute parent # - # @return [FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Departments::Parent, nil] + # @return [FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Departments::Parent, nil] optional :parent, - -> { FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Departments::Parent } + -> { + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Departments::Parent + } # @!method initialize(name: nil, parent: nil) # @param name [Boolean] - # @param parent [FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Departments::Parent] + # @param parent [FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Departments::Parent] - # @see FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Departments#parent + # @see FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Departments#parent class Parent < FinchAPI::Internal::Type::BaseModel # @!attribute name # @@ -248,7 +266,7 @@ class Parent < FinchAPI::Internal::Type::BaseModel end end - # @see FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company#entity + # @see FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company#entity class Entity < FinchAPI::Internal::Type::BaseModel # @!attribute subtype # @@ -265,7 +283,7 @@ class Entity < FinchAPI::Internal::Type::BaseModel # @param type [Boolean] end - # @see FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company#locations + # @see FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company#locations class Locations < FinchAPI::Internal::Type::BaseModel # @!attribute city # @@ -307,25 +325,29 @@ class Locations < FinchAPI::Internal::Type::BaseModel end end - # @see FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields#directory + # @see FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields#directory class Directory < FinchAPI::Internal::Type::BaseModel # @!attribute individuals # - # @return [FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory::Individuals, nil] + # @return [FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory::Individuals, nil] optional :individuals, - -> { FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory::Individuals } + -> { + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory::Individuals + } # @!attribute paging # - # @return [FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory::Paging, nil] + # @return [FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory::Paging, nil] optional :paging, - -> { FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory::Paging } + -> { + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory::Paging + } # @!method initialize(individuals: nil, paging: nil) - # @param individuals [FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory::Individuals] - # @param paging [FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory::Paging] + # @param individuals [FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory::Individuals] + # @param paging [FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory::Paging] - # @see FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory#individuals + # @see FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory#individuals class Individuals < FinchAPI::Internal::Type::BaseModel # @!attribute id # @@ -354,9 +376,11 @@ class Individuals < FinchAPI::Internal::Type::BaseModel # @!attribute manager # - # @return [FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory::Individuals::Manager, nil] + # @return [FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory::Individuals::Manager, nil] optional :manager, - -> { FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory::Individuals::Manager } + -> { + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory::Individuals::Manager + } # @!attribute middle_name # @@ -369,10 +393,10 @@ class Individuals < FinchAPI::Internal::Type::BaseModel # @param first_name [Boolean] # @param is_active [Boolean] # @param last_name [Boolean] - # @param manager [FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory::Individuals::Manager] + # @param manager [FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory::Individuals::Manager] # @param middle_name [Boolean] - # @see FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory::Individuals#manager + # @see FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory::Individuals#manager class Manager < FinchAPI::Internal::Type::BaseModel # @!attribute id # @@ -384,7 +408,7 @@ class Manager < FinchAPI::Internal::Type::BaseModel end end - # @see FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory#paging + # @see FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory#paging class Paging < FinchAPI::Internal::Type::BaseModel # @!attribute count # @@ -402,7 +426,7 @@ class Paging < FinchAPI::Internal::Type::BaseModel end end - # @see FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields#employment + # @see FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields#employment class Employment < FinchAPI::Internal::Type::BaseModel # @!attribute id # @@ -421,15 +445,19 @@ class Employment < FinchAPI::Internal::Type::BaseModel # @!attribute department # - # @return [FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Department, nil] + # @return [FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Department, nil] optional :department, - -> { FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Department } + -> { + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Department + } # @!attribute employment # - # @return [FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Employment, nil] + # @return [FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Employment, nil] optional :employment, - -> { FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Employment } + -> { + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Employment + } # @!attribute employment_status # @@ -448,9 +476,11 @@ class Employment < FinchAPI::Internal::Type::BaseModel # @!attribute income # - # @return [FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Income, nil] + # @return [FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Income, nil] optional :income, - -> { FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Income } + -> { + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Income + } # @!attribute income_history # @@ -469,15 +499,19 @@ class Employment < FinchAPI::Internal::Type::BaseModel # @!attribute location # - # @return [FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Location, nil] + # @return [FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Location, nil] optional :location, - -> { FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Location } + -> { + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Location + } # @!attribute manager # - # @return [FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Manager, nil] + # @return [FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Manager, nil] optional :manager, - -> { FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Manager } + -> { + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Manager + } # @!attribute middle_name # @@ -498,22 +532,22 @@ class Employment < FinchAPI::Internal::Type::BaseModel # @param id [Boolean] # @param class_code [Boolean] # @param custom_fields [Boolean] - # @param department [FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Department] - # @param employment [FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Employment] + # @param department [FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Department] + # @param employment [FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Employment] # @param employment_status [Boolean] # @param end_date [Boolean] # @param first_name [Boolean] - # @param income [FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Income] + # @param income [FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Income] # @param income_history [Boolean] # @param is_active [Boolean] # @param last_name [Boolean] - # @param location [FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Location] - # @param manager [FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Manager] + # @param location [FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Location] + # @param manager [FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Manager] # @param middle_name [Boolean] # @param start_date [Boolean] # @param title [Boolean] - # @see FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment#department + # @see FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment#department class Department < FinchAPI::Internal::Type::BaseModel # @!attribute name # @@ -524,7 +558,7 @@ class Department < FinchAPI::Internal::Type::BaseModel # @param name [Boolean] end - # @see FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment#employment + # @see FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment#employment class Employment < FinchAPI::Internal::Type::BaseModel # @!attribute subtype # @@ -541,7 +575,7 @@ class Employment < FinchAPI::Internal::Type::BaseModel # @param type [Boolean] end - # @see FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment#income + # @see FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment#income class Income < FinchAPI::Internal::Type::BaseModel # @!attribute amount # @@ -564,7 +598,7 @@ class Income < FinchAPI::Internal::Type::BaseModel # @param unit [Boolean] end - # @see FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment#location + # @see FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment#location class Location < FinchAPI::Internal::Type::BaseModel # @!attribute city # @@ -605,7 +639,7 @@ class Location < FinchAPI::Internal::Type::BaseModel # @param state [Boolean] end - # @see FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment#manager + # @see FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment#manager class Manager < FinchAPI::Internal::Type::BaseModel # @!attribute id # @@ -617,7 +651,7 @@ class Manager < FinchAPI::Internal::Type::BaseModel end end - # @see FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields#individual + # @see FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields#individual class Individual < FinchAPI::Internal::Type::BaseModel # @!attribute id # @@ -631,9 +665,11 @@ class Individual < FinchAPI::Internal::Type::BaseModel # @!attribute emails # - # @return [FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual::Emails, nil] + # @return [FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual::Emails, nil] optional :emails, - -> { FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual::Emails } + -> { + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual::Emails + } # @!attribute encrypted_ssn # @@ -667,9 +703,11 @@ class Individual < FinchAPI::Internal::Type::BaseModel # @!attribute phone_numbers # - # @return [FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual::PhoneNumbers, nil] + # @return [FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual::PhoneNumbers, nil] optional :phone_numbers, - -> { FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual::PhoneNumbers } + -> { + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual::PhoneNumbers + } # @!attribute preferred_name # @@ -678,9 +716,11 @@ class Individual < FinchAPI::Internal::Type::BaseModel # @!attribute residence # - # @return [FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual::Residence, nil] + # @return [FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual::Residence, nil] optional :residence, - -> { FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual::Residence } + -> { + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual::Residence + } # @!attribute ssn # @@ -690,19 +730,19 @@ class Individual < FinchAPI::Internal::Type::BaseModel # @!method initialize(id: nil, dob: nil, emails: nil, encrypted_ssn: nil, ethnicity: nil, first_name: nil, gender: nil, last_name: nil, middle_name: nil, phone_numbers: nil, preferred_name: nil, residence: nil, ssn: nil) # @param id [Boolean] # @param dob [Boolean] - # @param emails [FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual::Emails] + # @param emails [FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual::Emails] # @param encrypted_ssn [Boolean] # @param ethnicity [Boolean] # @param first_name [Boolean] # @param gender [Boolean] # @param last_name [Boolean] # @param middle_name [Boolean] - # @param phone_numbers [FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual::PhoneNumbers] + # @param phone_numbers [FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual::PhoneNumbers] # @param preferred_name [Boolean] - # @param residence [FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual::Residence] + # @param residence [FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual::Residence] # @param ssn [Boolean] - # @see FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual#emails + # @see FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual#emails class Emails < FinchAPI::Internal::Type::BaseModel # @!attribute data # @@ -719,7 +759,7 @@ class Emails < FinchAPI::Internal::Type::BaseModel # @param type [Boolean] end - # @see FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual#phone_numbers + # @see FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual#phone_numbers class PhoneNumbers < FinchAPI::Internal::Type::BaseModel # @!attribute data # @@ -736,7 +776,7 @@ class PhoneNumbers < FinchAPI::Internal::Type::BaseModel # @param type [Boolean] end - # @see FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual#residence + # @see FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual#residence class Residence < FinchAPI::Internal::Type::BaseModel # @!attribute city # @@ -778,7 +818,7 @@ class Residence < FinchAPI::Internal::Type::BaseModel end end - # @see FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields#pay_group + # @see FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields#pay_group class PayGroup < FinchAPI::Internal::Type::BaseModel # @!attribute id # @@ -807,25 +847,29 @@ class PayGroup < FinchAPI::Internal::Type::BaseModel # @param pay_frequencies [Boolean] end - # @see FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields#pay_statement + # @see FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields#pay_statement class PayStatement < FinchAPI::Internal::Type::BaseModel # @!attribute paging # - # @return [FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::Paging, nil] + # @return [FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::Paging, nil] optional :paging, - -> { FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::Paging } + -> { + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::Paging + } # @!attribute pay_statements # - # @return [FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements, nil] + # @return [FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements, nil] optional :pay_statements, - -> { FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements } + -> { + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements + } # @!method initialize(paging: nil, pay_statements: nil) - # @param paging [FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::Paging] - # @param pay_statements [FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements] + # @param paging [FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::Paging] + # @param pay_statements [FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements] - # @see FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement#paging + # @see FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement#paging class Paging < FinchAPI::Internal::Type::BaseModel # @!attribute count # @@ -842,25 +886,31 @@ class Paging < FinchAPI::Internal::Type::BaseModel # @param offset [Boolean] end - # @see FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement#pay_statements + # @see FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement#pay_statements class PayStatements < FinchAPI::Internal::Type::BaseModel # @!attribute earnings # - # @return [FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Earnings, nil] + # @return [FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Earnings, nil] optional :earnings, - -> { FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Earnings } + -> { + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Earnings + } # @!attribute employee_deductions # - # @return [FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployeeDeductions, nil] + # @return [FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployeeDeductions, nil] optional :employee_deductions, - -> { FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployeeDeductions } + -> { + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployeeDeductions + } # @!attribute employer_contributions # - # @return [FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployerContributions, nil] + # @return [FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployerContributions, nil] optional :employer_contributions, - -> { FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployerContributions } + -> { + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployerContributions + } # @!attribute gross_pay # @@ -884,9 +934,11 @@ class PayStatements < FinchAPI::Internal::Type::BaseModel # @!attribute taxes # - # @return [FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Taxes, nil] + # @return [FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Taxes, nil] optional :taxes, - -> { FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Taxes } + -> { + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Taxes + } # @!attribute total_hours # @@ -899,18 +951,18 @@ class PayStatements < FinchAPI::Internal::Type::BaseModel optional :type, FinchAPI::Internal::Type::Boolean # @!method initialize(earnings: nil, employee_deductions: nil, employer_contributions: nil, gross_pay: nil, individual_id: nil, net_pay: nil, payment_method: nil, taxes: nil, total_hours: nil, type: nil) - # @param earnings [FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Earnings] - # @param employee_deductions [FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployeeDeductions] - # @param employer_contributions [FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployerContributions] + # @param earnings [FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Earnings] + # @param employee_deductions [FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployeeDeductions] + # @param employer_contributions [FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployerContributions] # @param gross_pay [Boolean] # @param individual_id [Boolean] # @param net_pay [Boolean] # @param payment_method [Boolean] - # @param taxes [FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Taxes] + # @param taxes [FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Taxes] # @param total_hours [Boolean] # @param type [Boolean] - # @see FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements#earnings + # @see FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements#earnings class Earnings < FinchAPI::Internal::Type::BaseModel # @!attribute amount # @@ -939,7 +991,7 @@ class Earnings < FinchAPI::Internal::Type::BaseModel # @param type [Boolean] end - # @see FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements#employee_deductions + # @see FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements#employee_deductions class EmployeeDeductions < FinchAPI::Internal::Type::BaseModel # @!attribute amount # @@ -974,7 +1026,7 @@ class EmployeeDeductions < FinchAPI::Internal::Type::BaseModel # @param type [Boolean] end - # @see FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements#employer_contributions + # @see FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements#employer_contributions class EmployerContributions < FinchAPI::Internal::Type::BaseModel # @!attribute amount # @@ -997,7 +1049,7 @@ class EmployerContributions < FinchAPI::Internal::Type::BaseModel # @param name [Boolean] end - # @see FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements#taxes + # @see FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements#taxes class Taxes < FinchAPI::Internal::Type::BaseModel # @!attribute amount # @@ -1034,7 +1086,7 @@ class Taxes < FinchAPI::Internal::Type::BaseModel end end - # @see FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields#payment + # @see FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields#payment class Payment < FinchAPI::Internal::Type::BaseModel # @!attribute id # @@ -1093,9 +1145,11 @@ class Payment < FinchAPI::Internal::Type::BaseModel # @!attribute pay_period # - # @return [FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Payment::PayPeriod, nil] + # @return [FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Payment::PayPeriod, nil] optional :pay_period, - -> { FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Payment::PayPeriod } + -> { + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Payment::PayPeriod + } # @!method initialize(id: nil, company_debit: nil, debit_date: nil, employee_taxes: nil, employer_taxes: nil, gross_pay: nil, individual_ids: nil, net_pay: nil, pay_date: nil, pay_frequencies: nil, pay_group_ids: nil, pay_period: nil) # @param id [Boolean] @@ -1109,9 +1163,9 @@ class Payment < FinchAPI::Internal::Type::BaseModel # @param pay_date [Boolean] # @param pay_frequencies [Boolean] # @param pay_group_ids [Boolean] - # @param pay_period [FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Payment::PayPeriod] + # @param pay_period [FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Payment::PayPeriod] - # @see FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Payment#pay_period + # @see FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Payment#pay_period class PayPeriod < FinchAPI::Internal::Type::BaseModel # @!attribute end_date # @@ -1132,7 +1186,7 @@ class PayPeriod < FinchAPI::Internal::Type::BaseModel # The type of authentication method. # - # @see FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod#type + # @see FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod#type module Type extend FinchAPI::Internal::Type::Enum diff --git a/lib/finch_api/models/base_webhook_event.rb b/lib/finch_api/models/base_webhook_event.rb index 009b90fe..a9a05891 100644 --- a/lib/finch_api/models/base_webhook_event.rb +++ b/lib/finch_api/models/base_webhook_event.rb @@ -30,13 +30,11 @@ class BaseWebhookEvent < FinchAPI::Internal::Type::BaseModel # @!method initialize(account_id:, company_id:, connection_id: nil) # Some parameter documentations has been truncated, see - # {FinchAPI::Models::BaseWebhookEvent} for more details. + # {FinchAPI::BaseWebhookEvent} for more details. # # @param account_id [String] [DEPRECATED] Unique Finch ID of the employer account used to make this connectio - # ... # # @param company_id [String] [DEPRECATED] Unique Finch ID of the company for which data has been updated. Use - # ... # # @param connection_id [String] Unique Finch ID of the connection associated with the webhook event. end diff --git a/lib/finch_api/models/company_event.rb b/lib/finch_api/models/company_event.rb index c7f0c78e..e38fe662 100644 --- a/lib/finch_api/models/company_event.rb +++ b/lib/finch_api/models/company_event.rb @@ -10,12 +10,12 @@ class CompanyEvent < FinchAPI::Models::BaseWebhookEvent # @!attribute event_type # - # @return [Symbol, FinchAPI::Models::CompanyEvent::EventType, nil] - optional :event_type, enum: -> { FinchAPI::Models::CompanyEvent::EventType } + # @return [Symbol, FinchAPI::CompanyEvent::EventType, nil] + optional :event_type, enum: -> { FinchAPI::CompanyEvent::EventType } # @!method initialize(data: nil, event_type: nil) # @param data [Hash{Symbol=>Object}, nil] - # @param event_type [Symbol, FinchAPI::Models::CompanyEvent::EventType] + # @param event_type [Symbol, FinchAPI::CompanyEvent::EventType] module EventType extend FinchAPI::Internal::Type::Enum diff --git a/lib/finch_api/models/connect/session_new_params.rb b/lib/finch_api/models/connect/session_new_params.rb index bc646240..2fc7b944 100644 --- a/lib/finch_api/models/connect/session_new_params.rb +++ b/lib/finch_api/models/connect/session_new_params.rb @@ -20,9 +20,9 @@ class SessionNewParams < FinchAPI::Internal::Type::BaseModel # @!attribute products # - # @return [Array] + # @return [Array] required :products, - -> { FinchAPI::Internal::Type::ArrayOf[enum: FinchAPI::Models::Connect::SessionNewParams::Product] } + -> { FinchAPI::Internal::Type::ArrayOf[enum: FinchAPI::Connect::SessionNewParams::Product] } # @!attribute customer_email # @@ -31,8 +31,8 @@ class SessionNewParams < FinchAPI::Internal::Type::BaseModel # @!attribute integration # - # @return [FinchAPI::Models::Connect::SessionNewParams::Integration, nil] - optional :integration, -> { FinchAPI::Models::Connect::SessionNewParams::Integration }, nil?: true + # @return [FinchAPI::Connect::SessionNewParams::Integration, nil] + optional :integration, -> { FinchAPI::Connect::SessionNewParams::Integration }, nil?: true # @!attribute manual # @@ -53,8 +53,8 @@ class SessionNewParams < FinchAPI::Internal::Type::BaseModel # @!attribute sandbox # - # @return [Symbol, FinchAPI::Models::Connect::SessionNewParams::Sandbox, nil] - optional :sandbox, enum: -> { FinchAPI::Models::Connect::SessionNewParams::Sandbox }, nil?: true + # @return [Symbol, FinchAPI::Connect::SessionNewParams::Sandbox, nil] + optional :sandbox, enum: -> { FinchAPI::Connect::SessionNewParams::Sandbox }, nil?: true # @!method initialize(customer_id:, customer_name:, products:, customer_email: nil, integration: nil, manual: nil, minutes_to_expire: nil, redirect_uri: nil, sandbox: nil, request_options: {}) # Some parameter documentations has been truncated, see @@ -64,20 +64,19 @@ class SessionNewParams < FinchAPI::Internal::Type::BaseModel # # @param customer_name [String] # - # @param products [Array] + # @param products [Array] # # @param customer_email [String, nil] # - # @param integration [FinchAPI::Models::Connect::SessionNewParams::Integration, nil] + # @param integration [FinchAPI::Connect::SessionNewParams::Integration, nil] # # @param manual [Boolean, nil] # # @param minutes_to_expire [Float, nil] The number of minutes until the session expires (defaults to 43,200, which is 30 - # ... # # @param redirect_uri [String, nil] # - # @param sandbox [Symbol, FinchAPI::Models::Connect::SessionNewParams::Sandbox, nil] + # @param sandbox [Symbol, FinchAPI::Connect::SessionNewParams::Sandbox, nil] # # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}] @@ -103,9 +102,9 @@ module Product class Integration < FinchAPI::Internal::Type::BaseModel # @!attribute auth_method # - # @return [Symbol, FinchAPI::Models::Connect::SessionNewParams::Integration::AuthMethod, nil] + # @return [Symbol, FinchAPI::Connect::SessionNewParams::Integration::AuthMethod, nil] optional :auth_method, - enum: -> { FinchAPI::Models::Connect::SessionNewParams::Integration::AuthMethod }, + enum: -> { FinchAPI::Connect::SessionNewParams::Integration::AuthMethod }, nil?: true # @!attribute provider @@ -114,10 +113,10 @@ class Integration < FinchAPI::Internal::Type::BaseModel optional :provider, String, nil?: true # @!method initialize(auth_method: nil, provider: nil) - # @param auth_method [Symbol, FinchAPI::Models::Connect::SessionNewParams::Integration::AuthMethod, nil] + # @param auth_method [Symbol, FinchAPI::Connect::SessionNewParams::Integration::AuthMethod, nil] # @param provider [String, nil] - # @see FinchAPI::Models::Connect::SessionNewParams::Integration#auth_method + # @see FinchAPI::Connect::SessionNewParams::Integration#auth_method module AuthMethod extend FinchAPI::Internal::Type::Enum diff --git a/lib/finch_api/models/connect/session_reauthenticate_params.rb b/lib/finch_api/models/connect/session_reauthenticate_params.rb index 5bb61edf..0e885380 100644 --- a/lib/finch_api/models/connect/session_reauthenticate_params.rb +++ b/lib/finch_api/models/connect/session_reauthenticate_params.rb @@ -24,9 +24,11 @@ class SessionReauthenticateParams < FinchAPI::Internal::Type::BaseModel # @!attribute products # The products to request access to (optional for reauthentication) # - # @return [Array, nil] + # @return [Array, nil] optional :products, - -> { FinchAPI::Internal::Type::ArrayOf[enum: FinchAPI::Models::Connect::SessionReauthenticateParams::Product] }, + -> { + FinchAPI::Internal::Type::ArrayOf[enum: FinchAPI::Connect::SessionReauthenticateParams::Product] + }, nil?: true # @!attribute redirect_uri @@ -42,9 +44,8 @@ class SessionReauthenticateParams < FinchAPI::Internal::Type::BaseModel # @param connection_id [String] The ID of the existing connection to reauthenticate # # @param minutes_to_expire [Integer, nil] The number of minutes until the session expires (defaults to 43,200, which is 30 - # ... # - # @param products [Array, nil] The products to request access to (optional for reauthentication) + # @param products [Array, nil] The products to request access to (optional for reauthentication) # # @param redirect_uri [String, nil] The URI to redirect to after the Connect flow is completed # diff --git a/lib/finch_api/models/create_access_token_response.rb b/lib/finch_api/models/create_access_token_response.rb index dfc7b2a5..1b4a3b5a 100644 --- a/lib/finch_api/models/create_access_token_response.rb +++ b/lib/finch_api/models/create_access_token_response.rb @@ -22,8 +22,8 @@ class CreateAccessTokenResponse < FinchAPI::Internal::Type::BaseModel # @!attribute client_type # The type of application associated with a token. # - # @return [Symbol, FinchAPI::Models::CreateAccessTokenResponse::ClientType] - required :client_type, enum: -> { FinchAPI::Models::CreateAccessTokenResponse::ClientType } + # @return [Symbol, FinchAPI::CreateAccessTokenResponse::ClientType] + required :client_type, enum: -> { FinchAPI::CreateAccessTokenResponse::ClientType } # @!attribute company_id # @deprecated @@ -46,8 +46,8 @@ class CreateAccessTokenResponse < FinchAPI::Internal::Type::BaseModel # - `provider` - connection to an external provider # - `finch` - finch-generated data. # - # @return [Symbol, FinchAPI::Models::CreateAccessTokenResponse::ConnectionType] - required :connection_type, enum: -> { FinchAPI::Models::CreateAccessTokenResponse::ConnectionType } + # @return [Symbol, FinchAPI::CreateAccessTokenResponse::ConnectionType] + required :connection_type, enum: -> { FinchAPI::CreateAccessTokenResponse::ConnectionType } # @!attribute products # An array of the authorized products associated with the `access_token`. @@ -76,34 +76,31 @@ class CreateAccessTokenResponse < FinchAPI::Internal::Type::BaseModel # @!method initialize(access_token:, account_id:, client_type:, company_id:, connection_id:, connection_type:, products:, provider_id:, customer_id: nil, token_type: nil) # Some parameter documentations has been truncated, see - # {FinchAPI::Models::CreateAccessTokenResponse} for more details. + # {FinchAPI::CreateAccessTokenResponse} for more details. # # @param access_token [String] The access token for the connection. # # @param account_id [String] [DEPRECATED] Use `connection_id` to identify the connection instead of this acco - # ... # - # @param client_type [Symbol, FinchAPI::Models::CreateAccessTokenResponse::ClientType] The type of application associated with a token. + # @param client_type [Symbol, FinchAPI::CreateAccessTokenResponse::ClientType] The type of application associated with a token. # # @param company_id [String] [DEPRECATED] Use `connection_id` to identify the connection instead of this comp - # ... # # @param connection_id [String] The Finch UUID of the connection associated with the `access_token`. # - # @param connection_type [Symbol, FinchAPI::Models::CreateAccessTokenResponse::ConnectionType] The type of the connection associated with the token. ... + # @param connection_type [Symbol, FinchAPI::CreateAccessTokenResponse::ConnectionType] The type of the connection associated with the token. # # @param products [Array] An array of the authorized products associated with the `access_token`. # # @param provider_id [String] The ID of the provider associated with the `access_token`. # # @param customer_id [String, nil] The ID of your customer you provided to Finch when a connect session was created - # ... # # @param token_type [String] The RFC 8693 token type (Finch uses `bearer` tokens) # The type of application associated with a token. # - # @see FinchAPI::Models::CreateAccessTokenResponse#client_type + # @see FinchAPI::CreateAccessTokenResponse#client_type module ClientType extend FinchAPI::Internal::Type::Enum @@ -120,7 +117,7 @@ module ClientType # - `provider` - connection to an external provider # - `finch` - finch-generated data. # - # @see FinchAPI::Models::CreateAccessTokenResponse#connection_type + # @see FinchAPI::CreateAccessTokenResponse#connection_type module ConnectionType extend FinchAPI::Internal::Type::Enum diff --git a/lib/finch_api/models/directory_event.rb b/lib/finch_api/models/directory_event.rb index c9e5e027..ca759674 100644 --- a/lib/finch_api/models/directory_event.rb +++ b/lib/finch_api/models/directory_event.rb @@ -5,17 +5,17 @@ module Models class DirectoryEvent < FinchAPI::Models::BaseWebhookEvent # @!attribute data # - # @return [FinchAPI::Models::DirectoryEvent::Data, nil] - optional :data, -> { FinchAPI::Models::DirectoryEvent::Data } + # @return [FinchAPI::DirectoryEvent::Data, nil] + optional :data, -> { FinchAPI::DirectoryEvent::Data } # @!attribute event_type # - # @return [Symbol, FinchAPI::Models::DirectoryEvent::EventType, nil] - optional :event_type, enum: -> { FinchAPI::Models::DirectoryEvent::EventType } + # @return [Symbol, FinchAPI::DirectoryEvent::EventType, nil] + optional :event_type, enum: -> { FinchAPI::DirectoryEvent::EventType } # @!method initialize(data: nil, event_type: nil) - # @param data [FinchAPI::Models::DirectoryEvent::Data] - # @param event_type [Symbol, FinchAPI::Models::DirectoryEvent::EventType] + # @param data [FinchAPI::DirectoryEvent::Data] + # @param event_type [Symbol, FinchAPI::DirectoryEvent::EventType] class Data < FinchAPI::Internal::Type::BaseModel # @!attribute individual_id diff --git a/lib/finch_api/models/employment_event.rb b/lib/finch_api/models/employment_event.rb index 689a513e..12f3aa87 100644 --- a/lib/finch_api/models/employment_event.rb +++ b/lib/finch_api/models/employment_event.rb @@ -5,17 +5,17 @@ module Models class EmploymentEvent < FinchAPI::Models::BaseWebhookEvent # @!attribute data # - # @return [FinchAPI::Models::EmploymentEvent::Data, nil] - optional :data, -> { FinchAPI::Models::EmploymentEvent::Data } + # @return [FinchAPI::EmploymentEvent::Data, nil] + optional :data, -> { FinchAPI::EmploymentEvent::Data } # @!attribute event_type # - # @return [Symbol, FinchAPI::Models::EmploymentEvent::EventType, nil] - optional :event_type, enum: -> { FinchAPI::Models::EmploymentEvent::EventType } + # @return [Symbol, FinchAPI::EmploymentEvent::EventType, nil] + optional :event_type, enum: -> { FinchAPI::EmploymentEvent::EventType } # @!method initialize(data: nil, event_type: nil) - # @param data [FinchAPI::Models::EmploymentEvent::Data] - # @param event_type [Symbol, FinchAPI::Models::EmploymentEvent::EventType] + # @param data [FinchAPI::EmploymentEvent::Data] + # @param event_type [Symbol, FinchAPI::EmploymentEvent::EventType] class Data < FinchAPI::Internal::Type::BaseModel # @!attribute individual_id diff --git a/lib/finch_api/models/hris/benefit_contribution.rb b/lib/finch_api/models/hris/benefit_contribution.rb index 82dcd814..65654a7c 100644 --- a/lib/finch_api/models/hris/benefit_contribution.rb +++ b/lib/finch_api/models/hris/benefit_contribution.rb @@ -13,17 +13,17 @@ class BenefitContribution < FinchAPI::Internal::Type::BaseModel # @!attribute type # Contribution type. # - # @return [Symbol, FinchAPI::Models::HRIS::BenefitContribution::Type, nil] - optional :type, enum: -> { FinchAPI::Models::HRIS::BenefitContribution::Type }, nil?: true + # @return [Symbol, FinchAPI::HRIS::BenefitContribution::Type, nil] + optional :type, enum: -> { FinchAPI::HRIS::BenefitContribution::Type }, nil?: true # @!method initialize(amount: nil, type: nil) # @param amount [Integer, nil] Contribution amount in cents (if `fixed`) or basis points (if `percent`). # - # @param type [Symbol, FinchAPI::Models::HRIS::BenefitContribution::Type, nil] Contribution type. + # @param type [Symbol, FinchAPI::HRIS::BenefitContribution::Type, nil] Contribution type. # Contribution type. # - # @see FinchAPI::Models::HRIS::BenefitContribution#type + # @see FinchAPI::HRIS::BenefitContribution#type module Type extend FinchAPI::Internal::Type::Enum diff --git a/lib/finch_api/models/hris/benefit_create_params.rb b/lib/finch_api/models/hris/benefit_create_params.rb index f4b34d7c..ee01923d 100644 --- a/lib/finch_api/models/hris/benefit_create_params.rb +++ b/lib/finch_api/models/hris/benefit_create_params.rb @@ -11,9 +11,9 @@ class BenefitCreateParams < FinchAPI::Internal::Type::BaseModel # @!attribute company_contribution # The company match for this benefit. # - # @return [FinchAPI::Models::HRIS::BenefitCreateParams::CompanyContribution, nil] + # @return [FinchAPI::HRIS::BenefitCreateParams::CompanyContribution, nil] optional :company_contribution, - -> { FinchAPI::Models::HRIS::BenefitCreateParams::CompanyContribution }, + -> { FinchAPI::HRIS::BenefitCreateParams::CompanyContribution }, nil?: true # @!attribute description @@ -27,47 +27,48 @@ class BenefitCreateParams < FinchAPI::Internal::Type::BaseModel # @!attribute frequency # The frequency of the benefit deduction/contribution. # - # @return [Symbol, FinchAPI::Models::HRIS::BenefitFrequency, nil] - optional :frequency, enum: -> { FinchAPI::Models::HRIS::BenefitFrequency }, nil?: true + # @return [Symbol, FinchAPI::HRIS::BenefitFrequency, nil] + optional :frequency, enum: -> { FinchAPI::HRIS::BenefitFrequency }, nil?: true # @!attribute type # Type of benefit. # - # @return [Symbol, FinchAPI::Models::HRIS::BenefitType, nil] - optional :type, enum: -> { FinchAPI::Models::HRIS::BenefitType }, nil?: true + # @return [Symbol, FinchAPI::HRIS::BenefitType, nil] + optional :type, enum: -> { FinchAPI::HRIS::BenefitType }, nil?: true # @!method initialize(company_contribution: nil, description: nil, frequency: nil, type: nil, request_options: {}) # Some parameter documentations has been truncated, see # {FinchAPI::Models::HRIS::BenefitCreateParams} for more details. # - # @param company_contribution [FinchAPI::Models::HRIS::BenefitCreateParams::CompanyContribution, nil] The company match for this benefit. + # @param company_contribution [FinchAPI::HRIS::BenefitCreateParams::CompanyContribution, nil] The company match for this benefit. # # @param description [String] Name of the benefit as it appears in the provider and pay statements. Recommend - # ... # - # @param frequency [Symbol, FinchAPI::Models::HRIS::BenefitFrequency, nil] The frequency of the benefit deduction/contribution. + # @param frequency [Symbol, FinchAPI::HRIS::BenefitFrequency, nil] The frequency of the benefit deduction/contribution. # - # @param type [Symbol, FinchAPI::Models::HRIS::BenefitType, nil] Type of benefit. + # @param type [Symbol, FinchAPI::HRIS::BenefitType, nil] Type of benefit. # # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}] class CompanyContribution < FinchAPI::Internal::Type::BaseModel # @!attribute tiers # - # @return [Array, nil] + # @return [Array, nil] optional :tiers, - -> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::Models::HRIS::BenefitCreateParams::CompanyContribution::Tier] } + -> { + FinchAPI::Internal::Type::ArrayOf[FinchAPI::HRIS::BenefitCreateParams::CompanyContribution::Tier] + } # @!attribute type # - # @return [Symbol, FinchAPI::Models::HRIS::BenefitCreateParams::CompanyContribution::Type, nil] - optional :type, enum: -> { FinchAPI::Models::HRIS::BenefitCreateParams::CompanyContribution::Type } + # @return [Symbol, FinchAPI::HRIS::BenefitCreateParams::CompanyContribution::Type, nil] + optional :type, enum: -> { FinchAPI::HRIS::BenefitCreateParams::CompanyContribution::Type } # @!method initialize(tiers: nil, type: nil) # The company match for this benefit. # - # @param tiers [Array] - # @param type [Symbol, FinchAPI::Models::HRIS::BenefitCreateParams::CompanyContribution::Type] + # @param tiers [Array] + # @param type [Symbol, FinchAPI::HRIS::BenefitCreateParams::CompanyContribution::Type] class Tier < FinchAPI::Internal::Type::BaseModel # @!attribute match @@ -85,7 +86,7 @@ class Tier < FinchAPI::Internal::Type::BaseModel # @param threshold [Integer] end - # @see FinchAPI::Models::HRIS::BenefitCreateParams::CompanyContribution#type + # @see FinchAPI::HRIS::BenefitCreateParams::CompanyContribution#type module Type extend FinchAPI::Internal::Type::Enum 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 7e665a05..5f08b15a 100644 --- a/lib/finch_api/models/hris/benefit_features_and_operations.rb +++ b/lib/finch_api/models/hris/benefit_features_and_operations.rb @@ -6,20 +6,19 @@ module HRIS class BenefitFeaturesAndOperations < FinchAPI::Internal::Type::BaseModel # @!attribute supported_features # - # @return [FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures, nil] - optional :supported_features, - -> { FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures } + # @return [FinchAPI::HRIS::BenefitFeaturesAndOperations::SupportedFeatures, nil] + optional :supported_features, -> { FinchAPI::HRIS::BenefitFeaturesAndOperations::SupportedFeatures } # @!attribute supported_operations # - # @return [FinchAPI::Models::HRIS::SupportPerBenefitType, nil] - optional :supported_operations, -> { FinchAPI::Models::HRIS::SupportPerBenefitType } + # @return [FinchAPI::HRIS::SupportPerBenefitType, nil] + optional :supported_operations, -> { FinchAPI::HRIS::SupportPerBenefitType } # @!method initialize(supported_features: nil, supported_operations: nil) - # @param supported_features [FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures] - # @param supported_operations [FinchAPI::Models::HRIS::SupportPerBenefitType] + # @param supported_features [FinchAPI::HRIS::BenefitFeaturesAndOperations::SupportedFeatures] + # @param supported_operations [FinchAPI::HRIS::SupportPerBenefitType] - # @see FinchAPI::Models::HRIS::BenefitFeaturesAndOperations#supported_features + # @see FinchAPI::HRIS::BenefitFeaturesAndOperations#supported_features class SupportedFeatures < FinchAPI::Internal::Type::BaseModel # @!attribute annual_maximum # Whether the provider supports an annual maximum for this benefit. @@ -38,14 +37,12 @@ class SupportedFeatures < FinchAPI::Internal::Type::BaseModel # Supported contribution types. An empty array indicates contributions are not # supported. # - # @return [Array, nil] + # @return [Array, nil] optional :company_contribution, - -> do - FinchAPI::Internal::Type::ArrayOf[ - enum: FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::CompanyContribution, - nil?: true - ] - end, + -> { + FinchAPI::Internal::Type::ArrayOf[enum: FinchAPI::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::CompanyContribution, + nil?: true] + }, nil?: true # @!attribute description @@ -57,54 +54,53 @@ class SupportedFeatures < FinchAPI::Internal::Type::BaseModel # Supported deduction types. An empty array indicates deductions are not # supported. # - # @return [Array, nil] + # @return [Array, nil] optional :employee_deduction, - -> { FinchAPI::Internal::Type::ArrayOf[enum: FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::EmployeeDeduction, nil?: true] }, + -> { + FinchAPI::Internal::Type::ArrayOf[enum: FinchAPI::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::EmployeeDeduction, + nil?: true] + }, nil?: true # @!attribute frequencies # The list of frequencies supported by the provider for this benefit # - # @return [Array, nil] + # @return [Array, nil] optional :frequencies, - -> { FinchAPI::Internal::Type::ArrayOf[enum: FinchAPI::Models::HRIS::BenefitFrequency, nil?: true] } + -> { + FinchAPI::Internal::Type::ArrayOf[enum: FinchAPI::HRIS::BenefitFrequency, nil?: true] + } # @!attribute hsa_contribution_limit # 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. # - # @return [Array, nil] + # @return [Array, nil] optional :hsa_contribution_limit, - -> do - FinchAPI::Internal::Type::ArrayOf[ - enum: FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::HsaContributionLimit, - nil?: true - ] - end, + -> { + FinchAPI::Internal::Type::ArrayOf[enum: FinchAPI::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::HsaContributionLimit, + nil?: true] + }, nil?: true # @!method initialize(annual_maximum: nil, catch_up: nil, company_contribution: nil, description: nil, employee_deduction: nil, frequencies: nil, hsa_contribution_limit: nil) # Some parameter documentations has been truncated, see - # {FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures} for - # more details. + # {FinchAPI::HRIS::BenefitFeaturesAndOperations::SupportedFeatures} for more + # details. # # @param annual_maximum [Boolean, nil] Whether the provider supports an annual maximum for this benefit. # # @param catch_up [Boolean, nil] Whether the provider supports catch up for this benefit. This field will only be - # ... # - # @param company_contribution [Array, nil] Supported contribution types. An empty array indicates contributions are not sup - # ... + # @param company_contribution [Array, nil] Supported contribution types. An empty array indicates contributions are not sup # # @param description [String, nil] # - # @param employee_deduction [Array, nil] Supported deduction types. An empty array indicates deductions are not supported - # ... + # @param employee_deduction [Array, nil] Supported deduction types. An empty array indicates deductions are not supported # - # @param frequencies [Array] The list of frequencies supported by the provider for this benefit + # @param frequencies [Array] The list of frequencies supported by the provider for this benefit # - # @param hsa_contribution_limit [Array, nil] Whether the provider supports HSA contribution limits. Empty if this feature is - # ... + # @param hsa_contribution_limit [Array, nil] Whether the provider supports HSA contribution limits. Empty if this feature is module CompanyContribution extend FinchAPI::Internal::Type::Enum diff --git a/lib/finch_api/models/hris/benefit_list_supported_benefits_response.rb b/lib/finch_api/models/hris/benefit_list_supported_benefits_response.rb index bddbd036..54e42bf2 100644 --- a/lib/finch_api/models/hris/benefit_list_supported_benefits_response.rb +++ b/lib/finch_api/models/hris/benefit_list_supported_benefits_response.rb @@ -44,9 +44,9 @@ class BenefitListSupportedBenefitsResponse < FinchAPI::Internal::Type::BaseModel # @!attribute frequencies # The list of frequencies supported by the provider for this benefit # - # @return [Array, nil] + # @return [Array, nil] optional :frequencies, - -> { FinchAPI::Internal::Type::ArrayOf[enum: FinchAPI::Models::HRIS::BenefitFrequency, nil?: true] } + -> { FinchAPI::Internal::Type::ArrayOf[enum: FinchAPI::HRIS::BenefitFrequency, nil?: true] } # @!attribute hsa_contribution_limit # Whether the provider supports HSA contribution limits. Empty if this feature is @@ -64,20 +64,16 @@ class BenefitListSupportedBenefitsResponse < FinchAPI::Internal::Type::BaseModel # @param annual_maximum [Boolean, nil] Whether the provider supports an annual maximum for this benefit. # # @param catch_up [Boolean, nil] Whether the provider supports catch up for this benefit. This field will only be - # ... # # @param company_contribution [Array, nil] Supported contribution types. An empty array indicates contributions are not sup - # ... # # @param description [String, nil] # # @param employee_deduction [Array, nil] Supported deduction types. An empty array indicates deductions are not supported - # ... # - # @param frequencies [Array] The list of frequencies supported by the provider for this benefit + # @param frequencies [Array] The list of frequencies supported by the provider for this benefit # # @param hsa_contribution_limit [Array, nil] Whether the provider supports HSA contribution limits. Empty if this feature is - # ... module CompanyContribution extend FinchAPI::Internal::Type::Enum diff --git a/lib/finch_api/models/hris/benefits/individual_benefit.rb b/lib/finch_api/models/hris/benefits/individual_benefit.rb index c5aa4f4a..26fc2ba4 100644 --- a/lib/finch_api/models/hris/benefits/individual_benefit.rb +++ b/lib/finch_api/models/hris/benefits/individual_benefit.rb @@ -8,8 +8,8 @@ module Benefits class IndividualBenefit < FinchAPI::Internal::Type::BaseModel # @!attribute body # - # @return [FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body, nil] - optional :body, -> { FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body } + # @return [FinchAPI::HRIS::Benefits::IndividualBenefit::Body, nil] + optional :body, -> { FinchAPI::HRIS::Benefits::IndividualBenefit::Body } # @!attribute code # @@ -22,11 +22,11 @@ class IndividualBenefit < FinchAPI::Internal::Type::BaseModel optional :individual_id, String # @!method initialize(body: nil, code: nil, individual_id: nil) - # @param body [FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body] + # @param body [FinchAPI::HRIS::Benefits::IndividualBenefit::Body] # @param code [Integer] # @param individual_id [String] - # @see FinchAPI::Models::HRIS::Benefits::IndividualBenefit#body + # @see FinchAPI::HRIS::Benefits::IndividualBenefit#body class Body < FinchAPI::Internal::Type::BaseModel # @!attribute annual_maximum # If the benefit supports annual maximum, the amount in cents for this individual. @@ -43,41 +43,39 @@ class Body < FinchAPI::Internal::Type::BaseModel # @!attribute company_contribution # - # @return [FinchAPI::Models::HRIS::BenefitContribution, nil] - optional :company_contribution, -> { FinchAPI::Models::HRIS::BenefitContribution }, nil?: true + # @return [FinchAPI::HRIS::BenefitContribution, nil] + optional :company_contribution, -> { FinchAPI::HRIS::BenefitContribution }, nil?: true # @!attribute employee_deduction # - # @return [FinchAPI::Models::HRIS::BenefitContribution, nil] - optional :employee_deduction, -> { FinchAPI::Models::HRIS::BenefitContribution }, nil?: true + # @return [FinchAPI::HRIS::BenefitContribution, nil] + optional :employee_deduction, -> { FinchAPI::HRIS::BenefitContribution }, nil?: true # @!attribute hsa_contribution_limit # Type for HSA contribution limit if the benefit is a HSA. # - # @return [Symbol, FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::HsaContributionLimit, nil] + # @return [Symbol, FinchAPI::HRIS::Benefits::IndividualBenefit::Body::HsaContributionLimit, nil] optional :hsa_contribution_limit, - enum: -> { FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::HsaContributionLimit }, + enum: -> { FinchAPI::HRIS::Benefits::IndividualBenefit::Body::HsaContributionLimit }, nil?: true # @!method initialize(annual_maximum: nil, catch_up: nil, company_contribution: nil, employee_deduction: nil, hsa_contribution_limit: nil) # Some parameter documentations has been truncated, see - # {FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body} for more details. + # {FinchAPI::HRIS::Benefits::IndividualBenefit::Body} for more details. # # @param annual_maximum [Integer, nil] If the benefit supports annual maximum, the amount in cents for this individual. - # ... # # @param catch_up [Boolean, nil] If the benefit supports catch up (401k, 403b, etc.), whether catch up is enabled - # ... # - # @param company_contribution [FinchAPI::Models::HRIS::BenefitContribution, nil] + # @param company_contribution [FinchAPI::HRIS::BenefitContribution, nil] # - # @param employee_deduction [FinchAPI::Models::HRIS::BenefitContribution, nil] + # @param employee_deduction [FinchAPI::HRIS::BenefitContribution, nil] # - # @param hsa_contribution_limit [Symbol, FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::HsaContributionLimit, nil] Type for HSA contribution limit if the benefit is a HSA. + # @param hsa_contribution_limit [Symbol, FinchAPI::HRIS::Benefits::IndividualBenefit::Body::HsaContributionLimit, nil] Type for HSA contribution limit if the benefit is a HSA. # Type for HSA contribution limit if the benefit is a HSA. # - # @see FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body#hsa_contribution_limit + # @see FinchAPI::HRIS::Benefits::IndividualBenefit::Body#hsa_contribution_limit module HsaContributionLimit extend FinchAPI::Internal::Type::Enum 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 21eafedc..651c1842 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 @@ -12,21 +12,23 @@ class IndividualEnrollManyParams < FinchAPI::Internal::Type::BaseModel # @!attribute individuals # Array of the individual_id to enroll and a configuration object. # - # @return [Array, nil] + # @return [Array, nil] optional :individuals, - -> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual] } + -> { + FinchAPI::Internal::Type::ArrayOf[FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual] + } # @!method initialize(individuals: nil, request_options: {}) - # @param individuals [Array] Array of the individual_id to enroll and a configuration object. + # @param individuals [Array] Array of the individual_id to enroll and a configuration object. # # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}] class Individual < FinchAPI::Internal::Type::BaseModel # @!attribute configuration # - # @return [FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration, nil] + # @return [FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration, nil] optional :configuration, - -> { FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration } + -> { FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration } # @!attribute individual_id # Finch id (uuidv4) for the individual to enroll @@ -35,19 +37,21 @@ class Individual < FinchAPI::Internal::Type::BaseModel optional :individual_id, String # @!method initialize(configuration: nil, individual_id: nil) - # @param configuration [FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration] + # @param configuration [FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration] # # @param individual_id [String] Finch id (uuidv4) for the individual to enroll - # @see FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual#configuration + # @see FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual#configuration class Configuration < FinchAPI::Internal::Type::BaseModel # @!attribute annual_contribution_limit # For HSA benefits only - whether the contribution limit is for an individual or # family # - # @return [Symbol, FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::AnnualContributionLimit, nil] + # @return [Symbol, FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::AnnualContributionLimit, nil] optional :annual_contribution_limit, - enum: -> { FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::AnnualContributionLimit } + enum: -> { + FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::AnnualContributionLimit + } # @!attribute annual_maximum # Maximum annual amount in cents @@ -63,9 +67,11 @@ class Configuration < FinchAPI::Internal::Type::BaseModel # @!attribute company_contribution # - # @return [FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution, nil] + # @return [FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution, nil] optional :company_contribution, - -> { FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution } + -> { + FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution + } # @!attribute effective_date # The date the enrollment will take effect @@ -75,32 +81,33 @@ class Configuration < FinchAPI::Internal::Type::BaseModel # @!attribute employee_deduction # - # @return [FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction, nil] + # @return [FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction, nil] optional :employee_deduction, - -> { FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction } + -> { + FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction + } # @!method initialize(annual_contribution_limit: nil, annual_maximum: nil, catch_up: nil, company_contribution: nil, effective_date: nil, employee_deduction: nil) # Some parameter documentations has been truncated, see - # {FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration} + # {FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration} # for more details. # - # @param annual_contribution_limit [Symbol, FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::AnnualContributionLimit] For HSA benefits only - whether the contribution limit is for an individual or f - # ... + # @param annual_contribution_limit [Symbol, FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::AnnualContributionLimit] For HSA benefits only - whether the contribution limit is for an individual or f # # @param annual_maximum [Integer, nil] Maximum annual amount in cents # # @param catch_up [Boolean] For retirement benefits only - whether catch up contributions are enabled # - # @param company_contribution [FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution] + # @param company_contribution [FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution] # # @param effective_date [Date] The date the enrollment will take effect # - # @param employee_deduction [FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction] + # @param employee_deduction [FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction] # For HSA benefits only - whether the contribution limit is for an individual or # family # - # @see FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration#annual_contribution_limit + # @see FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration#annual_contribution_limit module AnnualContributionLimit extend FinchAPI::Internal::Type::Enum @@ -111,7 +118,7 @@ module AnnualContributionLimit # @return [Array] end - # @see FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration#company_contribution + # @see FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration#company_contribution class CompanyContribution < FinchAPI::Internal::Type::BaseModel # @!attribute amount # Amount in cents for fixed type or basis points (1/100th of a percent) for @@ -122,21 +129,22 @@ class CompanyContribution < FinchAPI::Internal::Type::BaseModel # @!attribute type # - # @return [Symbol, FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution::Type, nil] + # @return [Symbol, FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution::Type, nil] optional :type, - enum: -> { FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution::Type } + enum: -> { + FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution::Type + } # @!method initialize(amount: nil, type: nil) # Some parameter documentations has been truncated, see - # {FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution} + # {FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution} # for more details. # # @param amount [Integer] Amount in cents for fixed type or basis points (1/100th of a percent) for percen - # ... # - # @param type [Symbol, FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution::Type] + # @param type [Symbol, FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution::Type] - # @see FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution#type + # @see FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution#type module Type extend FinchAPI::Internal::Type::Enum @@ -148,7 +156,7 @@ module Type end end - # @see FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration#employee_deduction + # @see FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration#employee_deduction class EmployeeDeduction < FinchAPI::Internal::Type::BaseModel # @!attribute amount # Amount in cents for fixed type or basis points (1/100th of a percent) for @@ -159,21 +167,22 @@ class EmployeeDeduction < FinchAPI::Internal::Type::BaseModel # @!attribute type # - # @return [Symbol, FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction::Type, nil] + # @return [Symbol, FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction::Type, nil] optional :type, - enum: -> { FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction::Type } + enum: -> { + FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction::Type + } # @!method initialize(amount: nil, type: nil) # Some parameter documentations has been truncated, see - # {FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction} + # {FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction} # for more details. # # @param amount [Integer] Amount in cents for fixed type or basis points (1/100th of a percent) for percen - # ... # - # @param type [Symbol, FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction::Type] + # @param type [Symbol, FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction::Type] - # @see FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction#type + # @see FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction#type module Type extend FinchAPI::Internal::Type::Enum diff --git a/lib/finch_api/models/hris/benefits/individual_retrieve_many_benefits_params.rb b/lib/finch_api/models/hris/benefits/individual_retrieve_many_benefits_params.rb index 4f9ee37c..6f061bb2 100644 --- a/lib/finch_api/models/hris/benefits/individual_retrieve_many_benefits_params.rb +++ b/lib/finch_api/models/hris/benefits/individual_retrieve_many_benefits_params.rb @@ -22,7 +22,6 @@ class IndividualRetrieveManyBenefitsParams < FinchAPI::Internal::Type::BaseModel # more details. # # @param individual_ids [String] comma-delimited list of stable Finch uuids for each individual. If empty, defaul - # ... # # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}] end diff --git a/lib/finch_api/models/hris/benefits_support.rb b/lib/finch_api/models/hris/benefits_support.rb index 4a07fc55..be897591 100644 --- a/lib/finch_api/models/hris/benefits_support.rb +++ b/lib/finch_api/models/hris/benefits_support.rb @@ -6,80 +6,80 @@ module HRIS class BenefitsSupport < FinchAPI::Internal::Type::BaseModel # @!attribute commuter # - # @return [FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, nil] - optional :commuter, -> { FinchAPI::Models::HRIS::BenefitFeaturesAndOperations }, nil?: true + # @return [FinchAPI::HRIS::BenefitFeaturesAndOperations, nil] + optional :commuter, -> { FinchAPI::HRIS::BenefitFeaturesAndOperations }, nil?: true # @!attribute custom_post_tax # - # @return [FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, nil] - optional :custom_post_tax, -> { FinchAPI::Models::HRIS::BenefitFeaturesAndOperations }, nil?: true + # @return [FinchAPI::HRIS::BenefitFeaturesAndOperations, nil] + optional :custom_post_tax, -> { FinchAPI::HRIS::BenefitFeaturesAndOperations }, nil?: true # @!attribute custom_pre_tax # - # @return [FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, nil] - optional :custom_pre_tax, -> { FinchAPI::Models::HRIS::BenefitFeaturesAndOperations }, nil?: true + # @return [FinchAPI::HRIS::BenefitFeaturesAndOperations, nil] + optional :custom_pre_tax, -> { FinchAPI::HRIS::BenefitFeaturesAndOperations }, nil?: true # @!attribute fsa_dependent_care # - # @return [FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, nil] - optional :fsa_dependent_care, -> { FinchAPI::Models::HRIS::BenefitFeaturesAndOperations }, nil?: true + # @return [FinchAPI::HRIS::BenefitFeaturesAndOperations, nil] + optional :fsa_dependent_care, -> { FinchAPI::HRIS::BenefitFeaturesAndOperations }, nil?: true # @!attribute fsa_medical # - # @return [FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, nil] - optional :fsa_medical, -> { FinchAPI::Models::HRIS::BenefitFeaturesAndOperations }, nil?: true + # @return [FinchAPI::HRIS::BenefitFeaturesAndOperations, nil] + optional :fsa_medical, -> { FinchAPI::HRIS::BenefitFeaturesAndOperations }, nil?: true # @!attribute hsa_post # - # @return [FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, nil] - optional :hsa_post, -> { FinchAPI::Models::HRIS::BenefitFeaturesAndOperations }, nil?: true + # @return [FinchAPI::HRIS::BenefitFeaturesAndOperations, nil] + optional :hsa_post, -> { FinchAPI::HRIS::BenefitFeaturesAndOperations }, nil?: true # @!attribute hsa_pre # - # @return [FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, nil] - optional :hsa_pre, -> { FinchAPI::Models::HRIS::BenefitFeaturesAndOperations }, nil?: true + # @return [FinchAPI::HRIS::BenefitFeaturesAndOperations, nil] + optional :hsa_pre, -> { FinchAPI::HRIS::BenefitFeaturesAndOperations }, nil?: true # @!attribute s125_dental # - # @return [FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, nil] - optional :s125_dental, -> { FinchAPI::Models::HRIS::BenefitFeaturesAndOperations }, nil?: true + # @return [FinchAPI::HRIS::BenefitFeaturesAndOperations, nil] + optional :s125_dental, -> { FinchAPI::HRIS::BenefitFeaturesAndOperations }, nil?: true # @!attribute s125_medical # - # @return [FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, nil] - optional :s125_medical, -> { FinchAPI::Models::HRIS::BenefitFeaturesAndOperations }, nil?: true + # @return [FinchAPI::HRIS::BenefitFeaturesAndOperations, nil] + optional :s125_medical, -> { FinchAPI::HRIS::BenefitFeaturesAndOperations }, nil?: true # @!attribute s125_vision # - # @return [FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, nil] - optional :s125_vision, -> { FinchAPI::Models::HRIS::BenefitFeaturesAndOperations }, nil?: true + # @return [FinchAPI::HRIS::BenefitFeaturesAndOperations, nil] + optional :s125_vision, -> { FinchAPI::HRIS::BenefitFeaturesAndOperations }, nil?: true # @!attribute simple # - # @return [FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, nil] - optional :simple, -> { FinchAPI::Models::HRIS::BenefitFeaturesAndOperations }, nil?: true + # @return [FinchAPI::HRIS::BenefitFeaturesAndOperations, nil] + optional :simple, -> { FinchAPI::HRIS::BenefitFeaturesAndOperations }, nil?: true # @!attribute simple_ira # - # @return [FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, nil] - optional :simple_ira, -> { FinchAPI::Models::HRIS::BenefitFeaturesAndOperations }, nil?: true + # @return [FinchAPI::HRIS::BenefitFeaturesAndOperations, nil] + optional :simple_ira, -> { FinchAPI::HRIS::BenefitFeaturesAndOperations }, nil?: true # @!method initialize(commuter: nil, custom_post_tax: nil, custom_pre_tax: nil, fsa_dependent_care: nil, fsa_medical: nil, hsa_post: nil, hsa_pre: nil, s125_dental: nil, s125_medical: nil, s125_vision: nil, simple: nil, simple_ira: nil) # Each benefit type and their supported features. If the benefit type is not # supported, the property will be null # - # @param commuter [FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, nil] - # @param custom_post_tax [FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, nil] - # @param custom_pre_tax [FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, nil] - # @param fsa_dependent_care [FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, nil] - # @param fsa_medical [FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, nil] - # @param hsa_post [FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, nil] - # @param hsa_pre [FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, nil] - # @param s125_dental [FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, nil] - # @param s125_medical [FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, nil] - # @param s125_vision [FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, nil] - # @param simple [FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, nil] - # @param simple_ira [FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, nil] + # @param commuter [FinchAPI::HRIS::BenefitFeaturesAndOperations, nil] + # @param custom_post_tax [FinchAPI::HRIS::BenefitFeaturesAndOperations, nil] + # @param custom_pre_tax [FinchAPI::HRIS::BenefitFeaturesAndOperations, nil] + # @param fsa_dependent_care [FinchAPI::HRIS::BenefitFeaturesAndOperations, nil] + # @param fsa_medical [FinchAPI::HRIS::BenefitFeaturesAndOperations, nil] + # @param hsa_post [FinchAPI::HRIS::BenefitFeaturesAndOperations, nil] + # @param hsa_pre [FinchAPI::HRIS::BenefitFeaturesAndOperations, nil] + # @param s125_dental [FinchAPI::HRIS::BenefitFeaturesAndOperations, nil] + # @param s125_medical [FinchAPI::HRIS::BenefitFeaturesAndOperations, nil] + # @param s125_vision [FinchAPI::HRIS::BenefitFeaturesAndOperations, nil] + # @param simple [FinchAPI::HRIS::BenefitFeaturesAndOperations, nil] + # @param simple_ira [FinchAPI::HRIS::BenefitFeaturesAndOperations, nil] end end end diff --git a/lib/finch_api/models/hris/company.rb b/lib/finch_api/models/hris/company.rb index 5c92f3bf..4f5f026e 100644 --- a/lib/finch_api/models/hris/company.rb +++ b/lib/finch_api/models/hris/company.rb @@ -14,17 +14,19 @@ class HRISCompany < FinchAPI::Internal::Type::BaseModel # @!attribute accounts # An array of bank account objects associated with the payroll/HRIS system. # - # @return [Array, nil] + # @return [Array, nil] required :accounts, - -> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::Models::HRIS::HRISCompany::Account] }, + -> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::HRIS::HRISCompany::Account] }, nil?: true # @!attribute departments # The array of company departments. # - # @return [Array, nil] + # @return [Array, nil] required :departments, - -> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::Models::HRIS::HRISCompany::Department, nil?: true] }, + -> { + FinchAPI::Internal::Type::ArrayOf[FinchAPI::HRIS::HRISCompany::Department, nil?: true] + }, nil?: true # @!attribute ein @@ -36,8 +38,8 @@ class HRISCompany < FinchAPI::Internal::Type::BaseModel # @!attribute entity # The entity type object. # - # @return [FinchAPI::Models::HRIS::HRISCompany::Entity, nil] - required :entity, -> { FinchAPI::Models::HRIS::HRISCompany::Entity }, nil?: true + # @return [FinchAPI::HRIS::HRISCompany::Entity, nil] + required :entity, -> { FinchAPI::HRIS::HRISCompany::Entity }, nil?: true # @!attribute legal_name # The legal name of the company. @@ -47,9 +49,11 @@ class HRISCompany < FinchAPI::Internal::Type::BaseModel # @!attribute locations # - # @return [Array, nil] + # @return [Array, nil] required :locations, - -> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::Models::Location, nil?: true] }, + -> { + FinchAPI::Internal::Type::ArrayOf[FinchAPI::Location, nil?: true] + }, nil?: true # @!attribute primary_email @@ -67,26 +71,25 @@ class HRISCompany < FinchAPI::Internal::Type::BaseModel # @!method initialize(id:, accounts:, departments:, ein:, entity:, legal_name:, locations:, primary_email:, primary_phone_number:) # Some parameter documentations has been truncated, see - # {FinchAPI::Models::HRIS::HRISCompany} for more details. + # {FinchAPI::HRIS::HRISCompany} for more details. # # @param id [String] A stable Finch `id` (UUID v4) for the company. # - # @param accounts [Array, nil] An array of bank account objects associated with the payroll/HRIS system. + # @param accounts [Array, nil] An array of bank account objects associated with the payroll/HRIS system. # - # @param departments [Array, nil] The array of company departments. + # @param departments [Array, nil] The array of company departments. # # @param ein [String, nil] The employer identification number. # - # @param entity [FinchAPI::Models::HRIS::HRISCompany::Entity, nil] The entity type object. + # @param entity [FinchAPI::HRIS::HRISCompany::Entity, nil] The entity type object. # # @param legal_name [String, nil] The legal name of the company. # - # @param locations [Array, nil] + # @param locations [Array, nil] # # @param primary_email [String, nil] The email of the main administrator on the account. # # @param primary_phone_number [String, nil] The phone number of the main administrator on the account. Format: E.164, with e - # ... class Account < FinchAPI::Internal::Type::BaseModel # @!attribute account_name @@ -104,8 +107,8 @@ class Account < FinchAPI::Internal::Type::BaseModel # @!attribute account_type # The type of bank account. # - # @return [Symbol, FinchAPI::Models::HRIS::HRISCompany::Account::AccountType, nil] - required :account_type, enum: -> { FinchAPI::Models::HRIS::HRISCompany::Account::AccountType }, nil?: true + # @return [Symbol, FinchAPI::HRIS::HRISCompany::Account::AccountType, nil] + required :account_type, enum: -> { FinchAPI::HRIS::HRISCompany::Account::AccountType }, nil?: true # @!attribute institution_name # Name of the banking institution. @@ -122,22 +125,21 @@ class Account < FinchAPI::Internal::Type::BaseModel # @!method initialize(account_name:, account_number:, account_type:, institution_name:, routing_number:) # Some parameter documentations has been truncated, see - # {FinchAPI::Models::HRIS::HRISCompany::Account} for more details. + # {FinchAPI::HRIS::HRISCompany::Account} for more details. # # @param account_name [String, nil] The name of the bank associated in the payroll/HRIS system. # # @param account_number [String, nil] 10-12 digit number to specify the bank account # - # @param account_type [Symbol, FinchAPI::Models::HRIS::HRISCompany::Account::AccountType, nil] The type of bank account. + # @param account_type [Symbol, FinchAPI::HRIS::HRISCompany::Account::AccountType, nil] The type of bank account. # # @param institution_name [String, nil] Name of the banking institution. # # @param routing_number [String, nil] A nine-digit code that's based on the U.S. Bank location where your account was - # ... # The type of bank account. # - # @see FinchAPI::Models::HRIS::HRISCompany::Account#account_type + # @see FinchAPI::HRIS::HRISCompany::Account#account_type module AccountType extend FinchAPI::Internal::Type::Enum @@ -159,15 +161,15 @@ class Department < FinchAPI::Internal::Type::BaseModel # @!attribute parent # The parent department, if present. # - # @return [FinchAPI::Models::HRIS::HRISCompany::Department::Parent, nil] - required :parent, -> { FinchAPI::Models::HRIS::HRISCompany::Department::Parent }, nil?: true + # @return [FinchAPI::HRIS::HRISCompany::Department::Parent, nil] + required :parent, -> { FinchAPI::HRIS::HRISCompany::Department::Parent }, nil?: true # @!method initialize(name:, parent:) # @param name [String, nil] The department name. # - # @param parent [FinchAPI::Models::HRIS::HRISCompany::Department::Parent, nil] The parent department, if present. + # @param parent [FinchAPI::HRIS::HRISCompany::Department::Parent, nil] The parent department, if present. - # @see FinchAPI::Models::HRIS::HRISCompany::Department#parent + # @see FinchAPI::HRIS::HRISCompany::Department#parent class Parent < FinchAPI::Internal::Type::BaseModel # @!attribute name # The parent department's name. @@ -182,30 +184,30 @@ class Parent < FinchAPI::Internal::Type::BaseModel end end - # @see FinchAPI::Models::HRIS::HRISCompany#entity + # @see FinchAPI::HRIS::HRISCompany#entity class Entity < FinchAPI::Internal::Type::BaseModel # @!attribute subtype # The tax payer subtype of the company. # - # @return [Symbol, FinchAPI::Models::HRIS::HRISCompany::Entity::Subtype, nil] - required :subtype, enum: -> { FinchAPI::Models::HRIS::HRISCompany::Entity::Subtype }, nil?: true + # @return [Symbol, FinchAPI::HRIS::HRISCompany::Entity::Subtype, nil] + required :subtype, enum: -> { FinchAPI::HRIS::HRISCompany::Entity::Subtype }, nil?: true # @!attribute type # The tax payer type of the company. # - # @return [Symbol, FinchAPI::Models::HRIS::HRISCompany::Entity::Type, nil] - required :type, enum: -> { FinchAPI::Models::HRIS::HRISCompany::Entity::Type }, nil?: true + # @return [Symbol, FinchAPI::HRIS::HRISCompany::Entity::Type, nil] + required :type, enum: -> { FinchAPI::HRIS::HRISCompany::Entity::Type }, nil?: true # @!method initialize(subtype:, type:) # The entity type object. # - # @param subtype [Symbol, FinchAPI::Models::HRIS::HRISCompany::Entity::Subtype, nil] The tax payer subtype of the company. + # @param subtype [Symbol, FinchAPI::HRIS::HRISCompany::Entity::Subtype, nil] The tax payer subtype of the company. # - # @param type [Symbol, FinchAPI::Models::HRIS::HRISCompany::Entity::Type, nil] The tax payer type of the company. + # @param type [Symbol, FinchAPI::HRIS::HRISCompany::Entity::Type, nil] The tax payer type of the company. # The tax payer subtype of the company. # - # @see FinchAPI::Models::HRIS::HRISCompany::Entity#subtype + # @see FinchAPI::HRIS::HRISCompany::Entity#subtype module Subtype extend FinchAPI::Internal::Type::Enum @@ -219,7 +221,7 @@ module Subtype # The tax payer type of the company. # - # @see FinchAPI::Models::HRIS::HRISCompany::Entity#type + # @see FinchAPI::HRIS::HRISCompany::Entity#type module Type extend FinchAPI::Internal::Type::Enum diff --git a/lib/finch_api/models/hris/company/pay_statement_item/rule_create_params.rb b/lib/finch_api/models/hris/company/pay_statement_item/rule_create_params.rb index fdb6dab0..f49100c1 100644 --- a/lib/finch_api/models/hris/company/pay_statement_item/rule_create_params.rb +++ b/lib/finch_api/models/hris/company/pay_statement_item/rule_create_params.rb @@ -13,15 +13,19 @@ class RuleCreateParams < FinchAPI::Internal::Type::BaseModel # @!attribute attributes # Specifies the fields to be applied when the condition is met. # - # @return [FinchAPI::Models::HRIS::Company::PayStatementItem::RuleCreateParams::Attributes, nil] + # @return [FinchAPI::HRIS::Company::PayStatementItem::RuleCreateParams::Attributes, nil] optional :attributes, - -> { FinchAPI::Models::HRIS::Company::PayStatementItem::RuleCreateParams::Attributes } + -> { + FinchAPI::HRIS::Company::PayStatementItem::RuleCreateParams::Attributes + } # @!attribute conditions # - # @return [Array, nil] + # @return [Array, nil] optional :conditions, - -> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::Models::HRIS::Company::PayStatementItem::RuleCreateParams::Condition] } + -> { + FinchAPI::Internal::Type::ArrayOf[FinchAPI::HRIS::Company::PayStatementItem::RuleCreateParams::Condition] + } # @!attribute effective_end_date # Specifies when the rules should stop applying rules based on the date. @@ -38,20 +42,20 @@ class RuleCreateParams < FinchAPI::Internal::Type::BaseModel # @!attribute entity_type # The entity type to which the rule is applied. # - # @return [Symbol, FinchAPI::Models::HRIS::Company::PayStatementItem::RuleCreateParams::EntityType, nil] + # @return [Symbol, FinchAPI::HRIS::Company::PayStatementItem::RuleCreateParams::EntityType, nil] optional :entity_type, - enum: -> { FinchAPI::Models::HRIS::Company::PayStatementItem::RuleCreateParams::EntityType } + enum: -> { FinchAPI::HRIS::Company::PayStatementItem::RuleCreateParams::EntityType } # @!method initialize(attributes: nil, conditions: nil, effective_end_date: nil, effective_start_date: nil, entity_type: nil, request_options: {}) - # @param attributes [FinchAPI::Models::HRIS::Company::PayStatementItem::RuleCreateParams::Attributes] Specifies the fields to be applied when the condition is met. + # @param attributes [FinchAPI::HRIS::Company::PayStatementItem::RuleCreateParams::Attributes] Specifies the fields to be applied when the condition is met. # - # @param conditions [Array] + # @param conditions [Array] # # @param effective_end_date [String, nil] Specifies when the rules should stop applying rules based on the date. # # @param effective_start_date [String, nil] Specifies when the rule should begin applying based on the date. # - # @param entity_type [Symbol, FinchAPI::Models::HRIS::Company::PayStatementItem::RuleCreateParams::EntityType] The entity type to which the rule is applied. + # @param entity_type [Symbol, FinchAPI::HRIS::Company::PayStatementItem::RuleCreateParams::EntityType] The entity type to which the rule is applied. # # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}] @@ -65,13 +69,12 @@ class Attributes < FinchAPI::Internal::Type::BaseModel # @!method initialize(metadata: nil) # Some parameter documentations has been truncated, see - # {FinchAPI::Models::HRIS::Company::PayStatementItem::RuleCreateParams::Attributes} - # for more details. + # {FinchAPI::HRIS::Company::PayStatementItem::RuleCreateParams::Attributes} for + # more details. # # Specifies the fields to be applied when the condition is met. # # @param metadata [Hash{Symbol=>Object}] The metadata to be attached in the entity. It is a key-value pairs where the val - # ... end class Condition < FinchAPI::Internal::Type::BaseModel @@ -84,9 +87,11 @@ class Condition < FinchAPI::Internal::Type::BaseModel # @!attribute operator # The operator to be used in the rule. # - # @return [Symbol, FinchAPI::Models::HRIS::Company::PayStatementItem::RuleCreateParams::Condition::Operator, nil] + # @return [Symbol, FinchAPI::HRIS::Company::PayStatementItem::RuleCreateParams::Condition::Operator, nil] optional :operator, - enum: -> { FinchAPI::Models::HRIS::Company::PayStatementItem::RuleCreateParams::Condition::Operator } + enum: -> { + FinchAPI::HRIS::Company::PayStatementItem::RuleCreateParams::Condition::Operator + } # @!attribute value # The value of the field to be checked in the rule. @@ -97,13 +102,13 @@ class Condition < FinchAPI::Internal::Type::BaseModel # @!method initialize(field: nil, operator: nil, value: nil) # @param field [String] The field to be checked in the rule. # - # @param operator [Symbol, FinchAPI::Models::HRIS::Company::PayStatementItem::RuleCreateParams::Condition::Operator] The operator to be used in the rule. + # @param operator [Symbol, FinchAPI::HRIS::Company::PayStatementItem::RuleCreateParams::Condition::Operator] The operator to be used in the rule. # # @param value [String] The value of the field to be checked in the rule. # The operator to be used in the rule. # - # @see FinchAPI::Models::HRIS::Company::PayStatementItem::RuleCreateParams::Condition#operator + # @see FinchAPI::HRIS::Company::PayStatementItem::RuleCreateParams::Condition#operator module Operator extend FinchAPI::Internal::Type::Enum diff --git a/lib/finch_api/models/hris/company/pay_statement_item/rule_create_response.rb b/lib/finch_api/models/hris/company/pay_statement_item/rule_create_response.rb index 4ce2bf1a..ae8a49d6 100644 --- a/lib/finch_api/models/hris/company/pay_statement_item/rule_create_response.rb +++ b/lib/finch_api/models/hris/company/pay_statement_item/rule_create_response.rb @@ -99,7 +99,6 @@ class Attributes < FinchAPI::Internal::Type::BaseModel # Specifies the fields to be applied when the condition is met. # # @param metadata [Hash{Symbol=>Object}] The metadata to be attached in the entity. It is a key-value pairs where the val - # ... end class Condition < FinchAPI::Internal::Type::BaseModel diff --git a/lib/finch_api/models/hris/company/pay_statement_item/rule_delete_response.rb b/lib/finch_api/models/hris/company/pay_statement_item/rule_delete_response.rb index 598c1f18..e512c887 100644 --- a/lib/finch_api/models/hris/company/pay_statement_item/rule_delete_response.rb +++ b/lib/finch_api/models/hris/company/pay_statement_item/rule_delete_response.rb @@ -107,7 +107,6 @@ class Attributes < FinchAPI::Internal::Type::BaseModel # Specifies the fields to be applied when the condition is met. # # @param metadata [Hash{Symbol=>Object}] The metadata to be attached in the entity. It is a key-value pairs where the val - # ... end class Condition < FinchAPI::Internal::Type::BaseModel diff --git a/lib/finch_api/models/hris/company/pay_statement_item/rule_list_response.rb b/lib/finch_api/models/hris/company/pay_statement_item/rule_list_response.rb index f0fcc954..ca8b7ac3 100644 --- a/lib/finch_api/models/hris/company/pay_statement_item/rule_list_response.rb +++ b/lib/finch_api/models/hris/company/pay_statement_item/rule_list_response.rb @@ -99,7 +99,6 @@ class Attributes < FinchAPI::Internal::Type::BaseModel # Specifies the fields to be applied when the condition is met. # # @param metadata [Hash{Symbol=>Object}] The metadata to be attached in the entity. It is a key-value pairs where the val - # ... end class Condition < FinchAPI::Internal::Type::BaseModel diff --git a/lib/finch_api/models/hris/company/pay_statement_item/rule_update_response.rb b/lib/finch_api/models/hris/company/pay_statement_item/rule_update_response.rb index 9eb95556..6882d427 100644 --- a/lib/finch_api/models/hris/company/pay_statement_item/rule_update_response.rb +++ b/lib/finch_api/models/hris/company/pay_statement_item/rule_update_response.rb @@ -99,7 +99,6 @@ class Attributes < FinchAPI::Internal::Type::BaseModel # Specifies the fields to be applied when the condition is met. # # @param metadata [Hash{Symbol=>Object}] The metadata to be attached in the entity. It is a key-value pairs where the val - # ... end class Condition < FinchAPI::Internal::Type::BaseModel diff --git a/lib/finch_api/models/hris/company/pay_statement_item_list_params.rb b/lib/finch_api/models/hris/company/pay_statement_item_list_params.rb index 9114e620..ae1a6c33 100644 --- a/lib/finch_api/models/hris/company/pay_statement_item_list_params.rb +++ b/lib/finch_api/models/hris/company/pay_statement_item_list_params.rb @@ -13,9 +13,11 @@ class PayStatementItemListParams < FinchAPI::Internal::Type::BaseModel # Comma-delimited list of pay statement item categories to filter on. If empty, # defaults to all categories. # - # @return [Array, nil] + # @return [Array, nil] optional :categories, - -> { FinchAPI::Internal::Type::ArrayOf[enum: FinchAPI::Models::HRIS::Company::PayStatementItemListParams::Category] } + -> { + FinchAPI::Internal::Type::ArrayOf[enum: FinchAPI::HRIS::Company::PayStatementItemListParams::Category] + } # @!attribute end_date # The end date to retrieve pay statement items by via their last seen pay date in @@ -47,16 +49,13 @@ class PayStatementItemListParams < FinchAPI::Internal::Type::BaseModel # Some parameter documentations has been truncated, see # {FinchAPI::Models::HRIS::Company::PayStatementItemListParams} for more details. # - # @param categories [Array] Comma-delimited list of pay statement item categories to filter on. If empty, de - # ... + # @param categories [Array] Comma-delimited list of pay statement item categories to filter on. If empty, de # # @param end_date [Date] The end date to retrieve pay statement items by via their last seen pay date in - # ... # # @param name [String] Case-insensitive partial match search by pay statement item name. # # @param start_date [Date] The start date to retrieve pay statement items by via their last seen pay date ( - # ... # # @param type [String] String search by pay statement item type. # diff --git a/lib/finch_api/models/hris/company/pay_statement_item_list_response.rb b/lib/finch_api/models/hris/company/pay_statement_item_list_response.rb index 6cd3030f..18cd7fdf 100644 --- a/lib/finch_api/models/hris/company/pay_statement_item_list_response.rb +++ b/lib/finch_api/models/hris/company/pay_statement_item_list_response.rb @@ -70,13 +70,10 @@ class Attributes < FinchAPI::Internal::Type::BaseModel # The attributes of the pay statement item. # # @param employer [Boolean, nil] `true` if the amount is paid by the employers. This field is only available for - # ... # # @param metadata [Hash{Symbol=>Object, nil}, nil] The metadata of the pay statement item derived by the rules engine if available. - # ... # # @param pre_tax [Boolean, nil] `true` if the pay statement item is pre-tax. This field is only available for em - # ... # # @param type [String, nil] The type of the pay statement item. end diff --git a/lib/finch_api/models/hris/company_benefit.rb b/lib/finch_api/models/hris/company_benefit.rb index 5727be60..2889eb8b 100644 --- a/lib/finch_api/models/hris/company_benefit.rb +++ b/lib/finch_api/models/hris/company_benefit.rb @@ -14,10 +14,8 @@ class CompanyBenefit < FinchAPI::Internal::Type::BaseModel # @!attribute company_contribution # The company match for this benefit. # - # @return [FinchAPI::Models::HRIS::CompanyBenefit::CompanyContribution, nil] - required :company_contribution, - -> { FinchAPI::Models::HRIS::CompanyBenefit::CompanyContribution }, - nil?: true + # @return [FinchAPI::HRIS::CompanyBenefit::CompanyContribution, nil] + required :company_contribution, -> { FinchAPI::HRIS::CompanyBenefit::CompanyContribution }, nil?: true # @!attribute description # @@ -27,44 +25,46 @@ class CompanyBenefit < FinchAPI::Internal::Type::BaseModel # @!attribute frequency # The frequency of the benefit deduction/contribution. # - # @return [Symbol, FinchAPI::Models::HRIS::BenefitFrequency, nil] - required :frequency, enum: -> { FinchAPI::Models::HRIS::BenefitFrequency }, nil?: true + # @return [Symbol, FinchAPI::HRIS::BenefitFrequency, nil] + required :frequency, enum: -> { FinchAPI::HRIS::BenefitFrequency }, nil?: true # @!attribute type # Type of benefit. # - # @return [Symbol, FinchAPI::Models::HRIS::BenefitType, nil] - required :type, enum: -> { FinchAPI::Models::HRIS::BenefitType }, nil?: true + # @return [Symbol, FinchAPI::HRIS::BenefitType, nil] + required :type, enum: -> { FinchAPI::HRIS::BenefitType }, nil?: true # @!method initialize(benefit_id:, company_contribution:, description:, frequency:, type:) # @param benefit_id [String] The id of the benefit. # - # @param company_contribution [FinchAPI::Models::HRIS::CompanyBenefit::CompanyContribution, nil] The company match for this benefit. + # @param company_contribution [FinchAPI::HRIS::CompanyBenefit::CompanyContribution, nil] The company match for this benefit. # # @param description [String, nil] # - # @param frequency [Symbol, FinchAPI::Models::HRIS::BenefitFrequency, nil] The frequency of the benefit deduction/contribution. + # @param frequency [Symbol, FinchAPI::HRIS::BenefitFrequency, nil] The frequency of the benefit deduction/contribution. # - # @param type [Symbol, FinchAPI::Models::HRIS::BenefitType, nil] Type of benefit. + # @param type [Symbol, FinchAPI::HRIS::BenefitType, nil] Type of benefit. - # @see FinchAPI::Models::HRIS::CompanyBenefit#company_contribution + # @see FinchAPI::HRIS::CompanyBenefit#company_contribution class CompanyContribution < FinchAPI::Internal::Type::BaseModel # @!attribute tiers # - # @return [Array, nil] + # @return [Array, nil] optional :tiers, - -> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::Models::HRIS::CompanyBenefit::CompanyContribution::Tier] } + -> { + FinchAPI::Internal::Type::ArrayOf[FinchAPI::HRIS::CompanyBenefit::CompanyContribution::Tier] + } # @!attribute type # - # @return [Symbol, FinchAPI::Models::HRIS::CompanyBenefit::CompanyContribution::Type, nil] - optional :type, enum: -> { FinchAPI::Models::HRIS::CompanyBenefit::CompanyContribution::Type } + # @return [Symbol, FinchAPI::HRIS::CompanyBenefit::CompanyContribution::Type, nil] + optional :type, enum: -> { FinchAPI::HRIS::CompanyBenefit::CompanyContribution::Type } # @!method initialize(tiers: nil, type: nil) # The company match for this benefit. # - # @param tiers [Array] - # @param type [Symbol, FinchAPI::Models::HRIS::CompanyBenefit::CompanyContribution::Type] + # @param tiers [Array] + # @param type [Symbol, FinchAPI::HRIS::CompanyBenefit::CompanyContribution::Type] class Tier < FinchAPI::Internal::Type::BaseModel # @!attribute match @@ -82,7 +82,7 @@ class Tier < FinchAPI::Internal::Type::BaseModel # @param threshold [Integer] end - # @see FinchAPI::Models::HRIS::CompanyBenefit::CompanyContribution#type + # @see FinchAPI::HRIS::CompanyBenefit::CompanyContribution#type module Type extend FinchAPI::Internal::Type::Enum diff --git a/lib/finch_api/models/hris/document_list_params.rb b/lib/finch_api/models/hris/document_list_params.rb index ba9cf0b3..dad9a92e 100644 --- a/lib/finch_api/models/hris/document_list_params.rb +++ b/lib/finch_api/models/hris/document_list_params.rb @@ -31,23 +31,23 @@ class DocumentListParams < FinchAPI::Internal::Type::BaseModel # Comma-delimited list of document types to filter on. If empty, defaults to all # types # - # @return [Array, nil] + # @return [Array, nil] optional :types, - -> { FinchAPI::Internal::Type::ArrayOf[enum: FinchAPI::Models::HRIS::DocumentListParams::Type] } + -> { + FinchAPI::Internal::Type::ArrayOf[enum: FinchAPI::HRIS::DocumentListParams::Type] + } # @!method initialize(individual_ids: nil, limit: nil, offset: nil, types: nil, request_options: {}) # Some parameter documentations has been truncated, see # {FinchAPI::Models::HRIS::DocumentListParams} for more details. # # @param individual_ids [Array] Comma-delimited list of stable Finch uuids for each individual. If empty, defaul - # ... # # @param limit [Integer] Number of documents to return (defaults to all) # # @param offset [Integer] Index to start from (defaults to 0) # - # @param types [Array] Comma-delimited list of document types to filter on. If empty, defaults to all t - # ... + # @param types [Array] Comma-delimited list of document types to filter on. If empty, defaults to all t # # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}] diff --git a/lib/finch_api/models/hris/document_list_response.rb b/lib/finch_api/models/hris/document_list_response.rb index f4803b98..c38768ab 100644 --- a/lib/finch_api/models/hris/document_list_response.rb +++ b/lib/finch_api/models/hris/document_list_response.rb @@ -7,17 +7,17 @@ module HRIS class DocumentListResponse < FinchAPI::Internal::Type::BaseModel # @!attribute documents # - # @return [Array] - required :documents, -> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::Models::HRIS::DocumentResponse] } + # @return [Array] + required :documents, -> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::HRIS::DocumentResponse] } # @!attribute paging # - # @return [FinchAPI::Models::Paging] - required :paging, -> { FinchAPI::Models::Paging } + # @return [FinchAPI::Paging] + required :paging, -> { FinchAPI::Paging } # @!method initialize(documents:, paging:) - # @param documents [Array] - # @param paging [FinchAPI::Models::Paging] + # @param documents [Array] + # @param paging [FinchAPI::Paging] end end end diff --git a/lib/finch_api/models/hris/document_response.rb b/lib/finch_api/models/hris/document_response.rb index 171dfddb..e0a68de4 100644 --- a/lib/finch_api/models/hris/document_response.rb +++ b/lib/finch_api/models/hris/document_response.rb @@ -20,8 +20,8 @@ class DocumentResponse < FinchAPI::Internal::Type::BaseModel # @!attribute type # The type of document. # - # @return [Symbol, FinchAPI::Models::HRIS::DocumentResponse::Type, nil] - optional :type, enum: -> { FinchAPI::Models::HRIS::DocumentResponse::Type } + # @return [Symbol, FinchAPI::HRIS::DocumentResponse::Type, nil] + optional :type, enum: -> { FinchAPI::HRIS::DocumentResponse::Type } # @!attribute url # A URL to access the document. Format: @@ -38,23 +38,21 @@ class DocumentResponse < FinchAPI::Internal::Type::BaseModel # @!method initialize(id: nil, individual_id: nil, type: nil, url: nil, year: nil) # Some parameter documentations has been truncated, see - # {FinchAPI::Models::HRIS::DocumentResponse} for more details. + # {FinchAPI::HRIS::DocumentResponse} for more details. # # @param id [String] A stable Finch id for the document. # # @param individual_id [String, nil] The ID of the individual associated with the document. This will be null for emp - # ... # - # @param type [Symbol, FinchAPI::Models::HRIS::DocumentResponse::Type] The type of document. + # @param type [Symbol, FinchAPI::HRIS::DocumentResponse::Type] The type of document. # # @param url [String] A URL to access the document. Format: `https://api.tryfinch.com/employer/documen - # ... # # @param year [Float, nil] The year the document applies to, if available. # The type of document. # - # @see FinchAPI::Models::HRIS::DocumentResponse#type + # @see FinchAPI::HRIS::DocumentResponse#type module Type extend FinchAPI::Internal::Type::Enum diff --git a/lib/finch_api/models/hris/document_retreive_response.rb b/lib/finch_api/models/hris/document_retreive_response.rb index 1ee01198..8b657bd6 100644 --- a/lib/finch_api/models/hris/document_retreive_response.rb +++ b/lib/finch_api/models/hris/document_retreive_response.rb @@ -13,13 +13,13 @@ module DocumentRetreiveResponse discriminator :type # A 2020 version of the W-4 tax form containing information on an individual's filing status, dependents, and withholding details. - variant :w4_2020, -> { FinchAPI::Models::HRIS::W42020 } + variant :w4_2020, -> { FinchAPI::HRIS::W42020 } # 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 } + variant :w4_2005, -> { FinchAPI::HRIS::W42005 } # @!method self.variants - # @return [Array(FinchAPI::Models::HRIS::W42020, FinchAPI::Models::HRIS::W42005)] + # @return [Array(FinchAPI::HRIS::W42020, FinchAPI::HRIS::W42005)] end end end diff --git a/lib/finch_api/models/hris/employment_data.rb b/lib/finch_api/models/hris/employment_data.rb index 138d21bc..54db06b8 100644 --- a/lib/finch_api/models/hris/employment_data.rb +++ b/lib/finch_api/models/hris/employment_data.rb @@ -3,302 +3,370 @@ module FinchAPI module Models module HRIS - class EmploymentData < FinchAPI::Internal::Type::BaseModel - # @!attribute id - # A stable Finch `id` (UUID v4) for an individual in the company. - # - # @return [String, nil] - optional :id, String - - # @!attribute class_code - # Worker's compensation classification code for this employee - # - # @return [String, nil] - optional :class_code, String, nil?: true - - # @!attribute custom_fields - # Custom fields for the individual. These are fields which are defined by the - # employer in the system. - # - # @return [Array, nil] - optional :custom_fields, - -> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::Models::HRIS::EmploymentData::CustomField] }, - nil?: true - - # @!attribute department - # The department object. - # - # @return [FinchAPI::Models::HRIS::EmploymentData::Department, nil] - optional :department, -> { FinchAPI::Models::HRIS::EmploymentData::Department }, nil?: true - - # @!attribute employment - # The employment object. - # - # @return [FinchAPI::Models::HRIS::EmploymentData::Employment, nil] - optional :employment, -> { FinchAPI::Models::HRIS::EmploymentData::Employment }, nil?: true - - # @!attribute employment_status - # The detailed employment status of the individual. Available options: `active`, - # `deceased`, `leave`, `onboarding`, `prehire`, `retired`, `terminated`. - # - # @return [Symbol, FinchAPI::Models::HRIS::EmploymentData::EmploymentStatus, nil] - optional :employment_status, - enum: -> { FinchAPI::Models::HRIS::EmploymentData::EmploymentStatus }, - nil?: true - - # @!attribute end_date - # - # @return [String, nil] - optional :end_date, String, nil?: true - - # @!attribute first_name - # The legal first name of the individual. - # - # @return [String, nil] - optional :first_name, String, nil?: true - - # @!attribute income - # 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. - # - # @return [FinchAPI::Models::Income, nil] - optional :income, -> { FinchAPI::Models::Income }, nil?: true - - # @!attribute income_history - # The array of income history. - # - # @return [Array, nil] - optional :income_history, - -> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::Models::Income, nil?: true] }, - nil?: true - - # @!attribute is_active - # `true` if the individual an an active employee or contractor at the company. - # - # @return [Boolean, nil] - optional :is_active, FinchAPI::Internal::Type::Boolean, nil?: true - - # @!attribute last_name - # The legal last name of the individual. - # - # @return [String, nil] - optional :last_name, String, nil?: true - - # @!attribute latest_rehire_date - # - # @return [String, nil] - optional :latest_rehire_date, String, nil?: true - - # @!attribute location - # - # @return [FinchAPI::Models::Location, nil] - optional :location, -> { FinchAPI::Models::Location }, nil?: true - - # @!attribute manager - # The manager object representing the manager of the individual within the org. - # - # @return [FinchAPI::Models::HRIS::EmploymentData::Manager, nil] - optional :manager, -> { FinchAPI::Models::HRIS::EmploymentData::Manager }, nil?: true - - # @!attribute middle_name - # The legal middle name of the individual. - # - # @return [String, nil] - optional :middle_name, String, nil?: true - - # @!attribute source_id - # The source system's unique employment identifier for this individual - # - # @return [String, nil] - optional :source_id, String, nil?: true - - # @!attribute start_date - # - # @return [String, nil] - optional :start_date, String, nil?: true - - # @!attribute title - # The current title of the individual. - # - # @return [String, nil] - optional :title, String, nil?: true - - # @!attribute work_id - # @deprecated - # - # This field is deprecated in favour of `source_id` - # - # @return [String, nil] - optional :work_id, String, nil?: true - - # @!method initialize(id: nil, class_code: nil, custom_fields: nil, department: nil, employment: nil, employment_status: nil, end_date: nil, first_name: nil, income: nil, income_history: nil, is_active: nil, last_name: nil, latest_rehire_date: nil, location: nil, manager: nil, middle_name: nil, source_id: nil, start_date: nil, title: nil, work_id: nil) - # Some parameter documentations has been truncated, see - # {FinchAPI::Models::HRIS::EmploymentData} for more details. - # - # @param id [String] A stable Finch `id` (UUID v4) for an individual in the company. - # - # @param class_code [String, nil] Worker's compensation classification code for this employee - # - # @param custom_fields [Array, nil] Custom fields for the individual. These are fields which are defined by the empl - # ... - # - # @param department [FinchAPI::Models::HRIS::EmploymentData::Department, nil] The department object. - # - # @param employment [FinchAPI::Models::HRIS::EmploymentData::Employment, nil] The employment object. - # - # @param employment_status [Symbol, FinchAPI::Models::HRIS::EmploymentData::EmploymentStatus, nil] The detailed employment status of the individual. Available options: `active`, ` - # ... - # - # @param end_date [String, nil] - # - # @param first_name [String, nil] The legal first name of the individual. - # - # @param income [FinchAPI::Models::Income, nil] The employee's income as reported by the provider. This may not always be annual - # ... - # - # @param income_history [Array, nil] The array of income history. - # - # @param is_active [Boolean, nil] `true` if the individual an an active employee or contractor at the company. - # - # @param last_name [String, nil] The legal last name of the individual. - # - # @param latest_rehire_date [String, nil] - # - # @param location [FinchAPI::Models::Location, nil] - # - # @param manager [FinchAPI::Models::HRIS::EmploymentData::Manager, nil] The manager object representing the manager of the individual within the org. - # - # @param middle_name [String, nil] The legal middle name of the individual. - # - # @param source_id [String, nil] The source system's unique employment identifier for this individual - # - # @param start_date [String, nil] - # - # @param title [String, nil] The current title of the individual. - # - # @param work_id [String, nil] This field is deprecated in favour of `source_id` - - class CustomField < FinchAPI::Internal::Type::BaseModel - # @!attribute name + module EmploymentData + extend FinchAPI::Internal::Type::Union + + variant -> { FinchAPI::HRIS::EmploymentData::UnionMember0 } + + variant -> { FinchAPI::HRIS::EmploymentData::BatchError } + + class UnionMember0 < FinchAPI::Internal::Type::BaseModel + # @!attribute id + # A stable Finch `id` (UUID v4) for an individual in the company. + # + # @return [String] + required :id, String + + # @!attribute class_code + # Worker's compensation classification code for this employee # # @return [String, nil] - optional :name, String + required :class_code, String, nil?: true - # @!attribute value + # @!attribute custom_fields + # Custom fields for the individual. These are fields which are defined by the + # employer in the system. + # + # @return [Array, nil] + required :custom_fields, + -> { + FinchAPI::Internal::Type::ArrayOf[FinchAPI::HRIS::EmploymentData::UnionMember0::CustomField] + }, + nil?: true + + # @!attribute department + # The department object. # - # @return [Object, nil] - optional :value, FinchAPI::Internal::Type::Unknown + # @return [FinchAPI::HRIS::EmploymentData::UnionMember0::Department, nil] + required :department, -> { FinchAPI::HRIS::EmploymentData::UnionMember0::Department }, nil?: true - # @!method initialize(name: nil, value: nil) - # @param name [String] - # @param value [Object] - end + # @!attribute employment + # The employment object. + # + # @return [FinchAPI::HRIS::EmploymentData::UnionMember0::Employment, nil] + required :employment, -> { FinchAPI::HRIS::EmploymentData::UnionMember0::Employment }, nil?: true - # @see FinchAPI::Models::HRIS::EmploymentData#department - class Department < FinchAPI::Internal::Type::BaseModel - # @!attribute name - # The name of the department associated with the individual. + # @!attribute employment_status + # The detailed employment status of the individual. Available options: `active`, + # `deceased`, `leave`, `onboarding`, `prehire`, `retired`, `terminated`. + # + # @return [Symbol, FinchAPI::HRIS::EmploymentData::UnionMember0::EmploymentStatus, nil] + required :employment_status, + enum: -> { FinchAPI::HRIS::EmploymentData::UnionMember0::EmploymentStatus }, + nil?: true + + # @!attribute end_date # # @return [String, nil] - optional :name, String, nil?: true + required :end_date, String, nil?: true - # @!method initialize(name: nil) - # The department object. + # @!attribute first_name + # The legal first name of the individual. # - # @param name [String, nil] The name of the department associated with the individual. - end + # @return [String, nil] + required :first_name, String, nil?: true - # @see FinchAPI::Models::HRIS::EmploymentData#employment - class Employment < FinchAPI::Internal::Type::BaseModel - # @!attribute subtype - # The secondary employment type of the individual. Options: `full_time`, - # `part_time`, `intern`, `temp`, `seasonal` and `individual_contractor`. + # @!attribute is_active + # `true` if the individual an an active employee or contractor at the company. # - # @return [Symbol, FinchAPI::Models::HRIS::EmploymentData::Employment::Subtype, nil] - optional :subtype, enum: -> { FinchAPI::Models::HRIS::EmploymentData::Employment::Subtype }, nil?: true + # @return [Boolean, nil] + required :is_active, FinchAPI::Internal::Type::Boolean, nil?: true - # @!attribute type - # The main employment type of the individual. + # @!attribute last_name + # The legal last name of the individual. # - # @return [Symbol, FinchAPI::Models::HRIS::EmploymentData::Employment::Type, nil] - optional :type, enum: -> { FinchAPI::Models::HRIS::EmploymentData::Employment::Type }, nil?: true + # @return [String, nil] + required :last_name, String, nil?: true - # @!method initialize(subtype: nil, type: nil) - # Some parameter documentations has been truncated, see - # {FinchAPI::Models::HRIS::EmploymentData::Employment} for more details. + # @!attribute latest_rehire_date # - # The employment object. + # @return [String, nil] + required :latest_rehire_date, String, nil?: true + + # @!attribute location # - # @param subtype [Symbol, FinchAPI::Models::HRIS::EmploymentData::Employment::Subtype, nil] The secondary employment type of the individual. Options: `full_time`, `part_tim - # ... + # @return [FinchAPI::Location, nil] + required :location, -> { FinchAPI::Location }, nil?: true + + # @!attribute manager + # The manager object representing the manager of the individual within the org. # - # @param type [Symbol, FinchAPI::Models::HRIS::EmploymentData::Employment::Type, nil] The main employment type of the individual. + # @return [FinchAPI::HRIS::EmploymentData::UnionMember0::Manager, nil] + required :manager, -> { FinchAPI::HRIS::EmploymentData::UnionMember0::Manager }, nil?: true - # The secondary employment type of the individual. Options: `full_time`, - # `part_time`, `intern`, `temp`, `seasonal` and `individual_contractor`. + # @!attribute middle_name + # The legal middle name of the individual. # - # @see FinchAPI::Models::HRIS::EmploymentData::Employment#subtype - module Subtype - extend FinchAPI::Internal::Type::Enum + # @return [String, nil] + required :middle_name, String, nil?: true - FULL_TIME = :full_time - INTERN = :intern - PART_TIME = :part_time - TEMP = :temp - SEASONAL = :seasonal - INDIVIDUAL_CONTRACTOR = :individual_contractor + # @!attribute source_id + # The source system's unique employment identifier for this individual + # + # @return [String, nil] + required :source_id, String, nil?: true - # @!method self.values - # @return [Array] + # @!attribute start_date + # + # @return [String, nil] + required :start_date, String, nil?: true + + # @!attribute title + # The current title of the individual. + # + # @return [String, nil] + required :title, String, nil?: true + + # @!attribute work_id + # @deprecated + # + # This field is deprecated in favour of `source_id` + # + # @return [String, nil] + required :work_id, String, nil?: true + + # @!attribute income + # 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. + # + # @return [FinchAPI::Income, nil] + optional :income, -> { FinchAPI::Income }, nil?: true + + # @!attribute income_history + # The array of income history. + # + # @return [Array, nil] + optional :income_history, + -> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::Income, nil?: true] }, + nil?: true + + # @!method initialize(id:, class_code:, custom_fields:, department:, employment:, employment_status:, end_date:, first_name:, is_active:, last_name:, latest_rehire_date:, location:, manager:, middle_name:, source_id:, start_date:, title:, work_id:, income: nil, income_history: nil) + # Some parameter documentations has been truncated, see + # {FinchAPI::HRIS::EmploymentData::UnionMember0} for more details. + # + # @param id [String] A stable Finch `id` (UUID v4) for an individual in the company. + # + # @param class_code [String, nil] Worker's compensation classification code for this employee + # + # @param custom_fields [Array, nil] Custom fields for the individual. These are fields which are defined by the empl + # + # @param department [FinchAPI::HRIS::EmploymentData::UnionMember0::Department, nil] The department object. + # + # @param employment [FinchAPI::HRIS::EmploymentData::UnionMember0::Employment, nil] The employment object. + # + # @param employment_status [Symbol, FinchAPI::HRIS::EmploymentData::UnionMember0::EmploymentStatus, nil] The detailed employment status of the individual. Available options: `active`, ` + # + # @param end_date [String, nil] + # + # @param first_name [String, nil] The legal first name of the individual. + # + # @param is_active [Boolean, nil] `true` if the individual an an active employee or contractor at the company. + # + # @param last_name [String, nil] The legal last name of the individual. + # + # @param latest_rehire_date [String, nil] + # + # @param location [FinchAPI::Location, nil] + # + # @param manager [FinchAPI::HRIS::EmploymentData::UnionMember0::Manager, nil] The manager object representing the manager of the individual within the org. + # + # @param middle_name [String, nil] The legal middle name of the individual. + # + # @param source_id [String, nil] The source system's unique employment identifier for this individual + # + # @param start_date [String, nil] + # + # @param title [String, nil] The current title of the individual. + # + # @param work_id [String, nil] This field is deprecated in favour of `source_id` + # + # @param income [FinchAPI::Income, nil] The employee's income as reported by the provider. This may not always be annual + # + # @param income_history [Array, nil] The array of income history. + + class CustomField < FinchAPI::Internal::Type::BaseModel + # @!attribute name + # + # @return [String, nil] + optional :name, String + + # @!attribute value + # + # @return [String, Array, Object, Float, Boolean, nil] + optional :value, + union: -> { FinchAPI::HRIS::EmploymentData::UnionMember0::CustomField::Value }, + nil?: true + + # @!method initialize(name: nil, value: nil) + # @param name [String] + # @param value [String, Array, Object, Float, Boolean, nil] + + # @see FinchAPI::HRIS::EmploymentData::UnionMember0::CustomField#value + module Value + extend FinchAPI::Internal::Type::Union + + variant String + + variant -> { + FinchAPI::HRIS::EmploymentData::UnionMember0::CustomField::Value::UnionMember1Array + } + + variant FinchAPI::Internal::Type::Unknown + + variant Float + + variant FinchAPI::Internal::Type::Boolean + + # @!method self.variants + # @return [Array(String, Array, Object, Float, Boolean)] + + # @type [FinchAPI::Internal::Type::Converter] + UnionMember1Array = FinchAPI::Internal::Type::ArrayOf[FinchAPI::Internal::Type::Unknown] + end + end + + # @see FinchAPI::HRIS::EmploymentData::UnionMember0#department + class Department < FinchAPI::Internal::Type::BaseModel + # @!attribute name + # The name of the department associated with the individual. + # + # @return [String, nil] + required :name, String, nil?: true + + # @!method initialize(name:) + # The department object. + # + # @param name [String, nil] The name of the department associated with the individual. end - # The main employment type of the individual. + # @see FinchAPI::HRIS::EmploymentData::UnionMember0#employment + class Employment < FinchAPI::Internal::Type::BaseModel + # @!attribute subtype + # The secondary employment type of the individual. Options: `full_time`, + # `part_time`, `intern`, `temp`, `seasonal` and `individual_contractor`. + # + # @return [Symbol, FinchAPI::HRIS::EmploymentData::UnionMember0::Employment::Subtype, nil] + required :subtype, + enum: -> { FinchAPI::HRIS::EmploymentData::UnionMember0::Employment::Subtype }, + nil?: true + + # @!attribute type + # The main employment type of the individual. + # + # @return [Symbol, FinchAPI::HRIS::EmploymentData::UnionMember0::Employment::Type, nil] + required :type, + enum: -> { + FinchAPI::HRIS::EmploymentData::UnionMember0::Employment::Type + }, + nil?: true + + # @!method initialize(subtype:, type:) + # Some parameter documentations has been truncated, see + # {FinchAPI::HRIS::EmploymentData::UnionMember0::Employment} for more details. + # + # The employment object. + # + # @param subtype [Symbol, FinchAPI::HRIS::EmploymentData::UnionMember0::Employment::Subtype, nil] The secondary employment type of the individual. Options: `full_time`, `part_tim + # + # @param type [Symbol, FinchAPI::HRIS::EmploymentData::UnionMember0::Employment::Type, nil] The main employment type of the individual. + + # The secondary employment type of the individual. Options: `full_time`, + # `part_time`, `intern`, `temp`, `seasonal` and `individual_contractor`. + # + # @see FinchAPI::HRIS::EmploymentData::UnionMember0::Employment#subtype + module Subtype + extend FinchAPI::Internal::Type::Enum + + FULL_TIME = :full_time + INTERN = :intern + PART_TIME = :part_time + TEMP = :temp + SEASONAL = :seasonal + INDIVIDUAL_CONTRACTOR = :individual_contractor + + # @!method self.values + # @return [Array] + end + + # The main employment type of the individual. + # + # @see FinchAPI::HRIS::EmploymentData::UnionMember0::Employment#type + module Type + extend FinchAPI::Internal::Type::Enum + + EMPLOYEE = :employee + CONTRACTOR = :contractor + + # @!method self.values + # @return [Array] + end + end + + # The detailed employment status of the individual. Available options: `active`, + # `deceased`, `leave`, `onboarding`, `prehire`, `retired`, `terminated`. # - # @see FinchAPI::Models::HRIS::EmploymentData::Employment#type - module Type + # @see FinchAPI::HRIS::EmploymentData::UnionMember0#employment_status + module EmploymentStatus extend FinchAPI::Internal::Type::Enum - EMPLOYEE = :employee - CONTRACTOR = :contractor + ACTIVE = :active + DECEASED = :deceased + LEAVE = :leave + ONBOARDING = :onboarding + PREHIRE = :prehire + RETIRED = :retired + TERMINATED = :terminated # @!method self.values # @return [Array] end - end - # The detailed employment status of the individual. Available options: `active`, - # `deceased`, `leave`, `onboarding`, `prehire`, `retired`, `terminated`. - # - # @see FinchAPI::Models::HRIS::EmploymentData#employment_status - module EmploymentStatus - extend FinchAPI::Internal::Type::Enum - - ACTIVE = :active - DECEASED = :deceased - LEAVE = :leave - ONBOARDING = :onboarding - PREHIRE = :prehire - RETIRED = :retired - TERMINATED = :terminated - - # @!method self.values - # @return [Array] + # @see FinchAPI::HRIS::EmploymentData::UnionMember0#manager + class Manager < FinchAPI::Internal::Type::BaseModel + # @!attribute id + # A stable Finch `id` (UUID v4) for an individual in the company. + # + # @return [String] + required :id, String + + # @!method initialize(id:) + # The manager object representing the manager of the individual within the org. + # + # @param id [String] A stable Finch `id` (UUID v4) for an individual in the company. + end end - # @see FinchAPI::Models::HRIS::EmploymentData#manager - class Manager < FinchAPI::Internal::Type::BaseModel - # @!attribute id - # A stable Finch `id` (UUID v4) for an individual in the company. + class BatchError < FinchAPI::Internal::Type::BaseModel + # @!attribute code # - # @return [String, nil] - optional :id, String + # @return [Float] + required :code, Float - # @!method initialize(id: nil) - # The manager object representing the manager of the individual within the org. + # @!attribute message # - # @param id [String] A stable Finch `id` (UUID v4) for an individual in the company. + # @return [String] + required :message, String + + # @!attribute name + # + # @return [String] + required :name, String + + # @!attribute finch_code + # + # @return [String, nil] + optional :finch_code, String + + # @!method initialize(code:, message:, name:, finch_code: nil) + # @param code [Float] + # @param message [String] + # @param name [String] + # @param finch_code [String] end + + # @!method self.variants + # @return [Array(FinchAPI::HRIS::EmploymentData::UnionMember0, FinchAPI::HRIS::EmploymentData::BatchError)] end end end diff --git a/lib/finch_api/models/hris/employment_data_response.rb b/lib/finch_api/models/hris/employment_data_response.rb index afdfe168..9f055e8b 100644 --- a/lib/finch_api/models/hris/employment_data_response.rb +++ b/lib/finch_api/models/hris/employment_data_response.rb @@ -7,22 +7,22 @@ module HRIS class EmploymentDataResponse < FinchAPI::Internal::Type::BaseModel # @!attribute body # - # @return [FinchAPI::Models::HRIS::EmploymentData, nil] - optional :body, -> { FinchAPI::Models::HRIS::EmploymentData } + # @return [FinchAPI::HRIS::EmploymentData::UnionMember0, FinchAPI::HRIS::EmploymentData::BatchError] + required :body, union: -> { FinchAPI::HRIS::EmploymentData } # @!attribute code # - # @return [Integer, nil] - optional :code, Integer + # @return [Integer] + required :code, Integer # @!attribute individual_id # A stable Finch `id` (UUID v4) for an individual in the company. # - # @return [String, nil] - optional :individual_id, String + # @return [String] + required :individual_id, String - # @!method initialize(body: nil, code: nil, individual_id: nil) - # @param body [FinchAPI::Models::HRIS::EmploymentData] + # @!method initialize(body:, code:, individual_id:) + # @param body [FinchAPI::HRIS::EmploymentData::UnionMember0, FinchAPI::HRIS::EmploymentData::BatchError] # # @param code [Integer] # diff --git a/lib/finch_api/models/hris/employment_retrieve_many_params.rb b/lib/finch_api/models/hris/employment_retrieve_many_params.rb index b15bf79b..e0e8d950 100644 --- a/lib/finch_api/models/hris/employment_retrieve_many_params.rb +++ b/lib/finch_api/models/hris/employment_retrieve_many_params.rb @@ -11,12 +11,14 @@ class EmploymentRetrieveManyParams < FinchAPI::Internal::Type::BaseModel # @!attribute requests # The array of batch requests. # - # @return [Array] + # @return [Array] required :requests, - -> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::Models::HRIS::EmploymentRetrieveManyParams::Request] } + -> { + FinchAPI::Internal::Type::ArrayOf[FinchAPI::HRIS::EmploymentRetrieveManyParams::Request] + } # @!method initialize(requests:, request_options: {}) - # @param requests [Array] The array of batch requests. + # @param requests [Array] The array of batch requests. # # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}] @@ -31,11 +33,9 @@ class Request < FinchAPI::Internal::Type::BaseModel # @!method initialize(individual_id:) # Some parameter documentations has been truncated, see - # {FinchAPI::Models::HRIS::EmploymentRetrieveManyParams::Request} for more - # details. + # {FinchAPI::HRIS::EmploymentRetrieveManyParams::Request} for more details. # # @param individual_id [String] A stable Finch `id` (UUID v4) for an individual in the company. There is no limi - # ... end end end diff --git a/lib/finch_api/models/hris/individual.rb b/lib/finch_api/models/hris/individual.rb index 0f8fdff8..1f32edba 100644 --- a/lib/finch_api/models/hris/individual.rb +++ b/lib/finch_api/models/hris/individual.rb @@ -6,9 +6,9 @@ module HRIS module Individual extend FinchAPI::Internal::Type::Union - variant -> { FinchAPI::Models::HRIS::Individual::UnionMember0 } + variant -> { FinchAPI::HRIS::Individual::UnionMember0 } - variant -> { FinchAPI::Models::HRIS::Individual::BatchError } + variant -> { FinchAPI::HRIS::Individual::BatchError } class UnionMember0 < FinchAPI::Internal::Type::BaseModel # @!attribute id @@ -25,8 +25,8 @@ class UnionMember0 < FinchAPI::Internal::Type::BaseModel # @!attribute ethnicity # The EEOC-defined ethnicity of the individual. # - # @return [Symbol, FinchAPI::Models::HRIS::Individual::UnionMember0::Ethnicity, nil] - required :ethnicity, enum: -> { FinchAPI::Models::HRIS::Individual::UnionMember0::Ethnicity }, nil?: true + # @return [Symbol, FinchAPI::HRIS::Individual::UnionMember0::Ethnicity, nil] + required :ethnicity, enum: -> { FinchAPI::HRIS::Individual::UnionMember0::Ethnicity }, nil?: true # @!attribute first_name # The legal first name of the individual. @@ -37,8 +37,8 @@ class UnionMember0 < FinchAPI::Internal::Type::BaseModel # @!attribute gender # The gender of the individual. # - # @return [Symbol, FinchAPI::Models::HRIS::Individual::UnionMember0::Gender, nil] - required :gender, enum: -> { FinchAPI::Models::HRIS::Individual::UnionMember0::Gender }, nil?: true + # @return [Symbol, FinchAPI::HRIS::Individual::UnionMember0::Gender, nil] + required :gender, enum: -> { FinchAPI::HRIS::Individual::UnionMember0::Gender }, nil?: true # @!attribute last_name # The legal last name of the individual. @@ -54,9 +54,12 @@ class UnionMember0 < FinchAPI::Internal::Type::BaseModel # @!attribute phone_numbers # - # @return [Array, nil] + # @return [Array, nil] required :phone_numbers, - -> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::Models::HRIS::Individual::UnionMember0::PhoneNumber, nil?: true] }, + -> { + FinchAPI::Internal::Type::ArrayOf[FinchAPI::HRIS::Individual::UnionMember0::PhoneNumber, + nil?: true] + }, nil?: true # @!attribute preferred_name @@ -67,14 +70,14 @@ class UnionMember0 < FinchAPI::Internal::Type::BaseModel # @!attribute residence # - # @return [FinchAPI::Models::Location, nil] - required :residence, -> { FinchAPI::Models::Location }, nil?: true + # @return [FinchAPI::Location, nil] + required :residence, -> { FinchAPI::Location }, nil?: true # @!attribute emails # - # @return [Array, nil] + # @return [Array, nil] optional :emails, - -> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::Models::HRIS::Individual::UnionMember0::Email] }, + -> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::HRIS::Individual::UnionMember0::Email] }, nil?: true # @!attribute encrypted_ssn @@ -96,39 +99,37 @@ class UnionMember0 < FinchAPI::Internal::Type::BaseModel # @!method initialize(id:, dob:, ethnicity:, first_name:, gender:, last_name:, middle_name:, phone_numbers:, preferred_name:, residence:, emails: nil, encrypted_ssn: nil, ssn: nil) # Some parameter documentations has been truncated, see - # {FinchAPI::Models::HRIS::Individual::UnionMember0} for more details. + # {FinchAPI::HRIS::Individual::UnionMember0} for more details. # # @param id [String] A stable Finch `id` (UUID v4) for an individual in the company. # # @param dob [String, nil] # - # @param ethnicity [Symbol, FinchAPI::Models::HRIS::Individual::UnionMember0::Ethnicity, nil] The EEOC-defined ethnicity of the individual. + # @param ethnicity [Symbol, FinchAPI::HRIS::Individual::UnionMember0::Ethnicity, nil] The EEOC-defined ethnicity of the individual. # # @param first_name [String, nil] The legal first name of the individual. # - # @param gender [Symbol, FinchAPI::Models::HRIS::Individual::UnionMember0::Gender, nil] The gender of the individual. + # @param gender [Symbol, FinchAPI::HRIS::Individual::UnionMember0::Gender, nil] The gender of the individual. # # @param last_name [String, nil] The legal last name of the individual. # # @param middle_name [String, nil] The legal middle name of the individual. # - # @param phone_numbers [Array, nil] + # @param phone_numbers [Array, nil] # # @param preferred_name [String, nil] The preferred name of the individual. # - # @param residence [FinchAPI::Models::Location, nil] + # @param residence [FinchAPI::Location, nil] # - # @param emails [Array, nil] + # @param emails [Array, nil] # # @param encrypted_ssn [String, nil] Social Security Number of the individual in **encrypted** format. This field is - # ... # # @param ssn [String, nil] Social Security Number of the individual. This field is only available with the - # ... # The EEOC-defined ethnicity of the individual. # - # @see FinchAPI::Models::HRIS::Individual::UnionMember0#ethnicity + # @see FinchAPI::HRIS::Individual::UnionMember0#ethnicity module Ethnicity extend FinchAPI::Internal::Type::Enum @@ -147,7 +148,7 @@ module Ethnicity # The gender of the individual. # - # @see FinchAPI::Models::HRIS::Individual::UnionMember0#gender + # @see FinchAPI::HRIS::Individual::UnionMember0#gender module Gender extend FinchAPI::Internal::Type::Enum @@ -168,16 +169,18 @@ class PhoneNumber < FinchAPI::Internal::Type::BaseModel # @!attribute type # - # @return [Symbol, FinchAPI::Models::HRIS::Individual::UnionMember0::PhoneNumber::Type, nil] + # @return [Symbol, FinchAPI::HRIS::Individual::UnionMember0::PhoneNumber::Type, nil] required :type, - enum: -> { FinchAPI::Models::HRIS::Individual::UnionMember0::PhoneNumber::Type }, + enum: -> { + FinchAPI::HRIS::Individual::UnionMember0::PhoneNumber::Type + }, nil?: true # @!method initialize(data:, type:) # @param data [String, nil] - # @param type [Symbol, FinchAPI::Models::HRIS::Individual::UnionMember0::PhoneNumber::Type, nil] + # @param type [Symbol, FinchAPI::HRIS::Individual::UnionMember0::PhoneNumber::Type, nil] - # @see FinchAPI::Models::HRIS::Individual::UnionMember0::PhoneNumber#type + # @see FinchAPI::HRIS::Individual::UnionMember0::PhoneNumber#type module Type extend FinchAPI::Internal::Type::Enum @@ -197,14 +200,14 @@ class Email < FinchAPI::Internal::Type::BaseModel # @!attribute type # - # @return [Symbol, FinchAPI::Models::HRIS::Individual::UnionMember0::Email::Type, nil] - required :type, enum: -> { FinchAPI::Models::HRIS::Individual::UnionMember0::Email::Type }, nil?: true + # @return [Symbol, FinchAPI::HRIS::Individual::UnionMember0::Email::Type, nil] + required :type, enum: -> { FinchAPI::HRIS::Individual::UnionMember0::Email::Type }, nil?: true # @!method initialize(data:, type:) # @param data [String] - # @param type [Symbol, FinchAPI::Models::HRIS::Individual::UnionMember0::Email::Type, nil] + # @param type [Symbol, FinchAPI::HRIS::Individual::UnionMember0::Email::Type, nil] - # @see FinchAPI::Models::HRIS::Individual::UnionMember0::Email#type + # @see FinchAPI::HRIS::Individual::UnionMember0::Email#type module Type extend FinchAPI::Internal::Type::Enum @@ -246,7 +249,7 @@ class BatchError < FinchAPI::Internal::Type::BaseModel end # @!method self.variants - # @return [Array(FinchAPI::Models::HRIS::Individual::UnionMember0, FinchAPI::Models::HRIS::Individual::BatchError)] + # @return [Array(FinchAPI::HRIS::Individual::UnionMember0, FinchAPI::HRIS::Individual::BatchError)] end end end diff --git a/lib/finch_api/models/hris/individual_in_directory.rb b/lib/finch_api/models/hris/individual_in_directory.rb index 987c5d38..f6d7ccb8 100644 --- a/lib/finch_api/models/hris/individual_in_directory.rb +++ b/lib/finch_api/models/hris/individual_in_directory.rb @@ -14,8 +14,8 @@ class IndividualInDirectory < FinchAPI::Internal::Type::BaseModel # @!attribute department # The department object. # - # @return [FinchAPI::Models::HRIS::IndividualInDirectory::Department, nil] - required :department, -> { FinchAPI::Models::HRIS::IndividualInDirectory::Department }, nil?: true + # @return [FinchAPI::HRIS::IndividualInDirectory::Department, nil] + required :department, -> { FinchAPI::HRIS::IndividualInDirectory::Department }, nil?: true # @!attribute first_name # The legal first name of the individual. @@ -38,8 +38,8 @@ class IndividualInDirectory < FinchAPI::Internal::Type::BaseModel # @!attribute manager # The manager object. # - # @return [FinchAPI::Models::HRIS::IndividualInDirectory::Manager, nil] - required :manager, -> { FinchAPI::Models::HRIS::IndividualInDirectory::Manager }, nil?: true + # @return [FinchAPI::HRIS::IndividualInDirectory::Manager, nil] + required :manager, -> { FinchAPI::HRIS::IndividualInDirectory::Manager }, nil?: true # @!attribute middle_name # The legal middle name of the individual. @@ -50,7 +50,7 @@ class IndividualInDirectory < FinchAPI::Internal::Type::BaseModel # @!method initialize(id:, department:, first_name:, is_active:, last_name:, manager:, middle_name:) # @param id [String] A stable Finch `id` (UUID v4) for an individual in the company. # - # @param department [FinchAPI::Models::HRIS::IndividualInDirectory::Department, nil] The department object. + # @param department [FinchAPI::HRIS::IndividualInDirectory::Department, nil] The department object. # # @param first_name [String, nil] The legal first name of the individual. # @@ -58,11 +58,11 @@ class IndividualInDirectory < FinchAPI::Internal::Type::BaseModel # # @param last_name [String, nil] The legal last name of the individual. # - # @param manager [FinchAPI::Models::HRIS::IndividualInDirectory::Manager, nil] The manager object. + # @param manager [FinchAPI::HRIS::IndividualInDirectory::Manager, nil] The manager object. # # @param middle_name [String, nil] The legal middle name of the individual. - # @see FinchAPI::Models::HRIS::IndividualInDirectory#department + # @see FinchAPI::HRIS::IndividualInDirectory#department class Department < FinchAPI::Internal::Type::BaseModel # @!attribute name # The name of the department. @@ -76,7 +76,7 @@ class Department < FinchAPI::Internal::Type::BaseModel # @param name [String, nil] The name of the department. end - # @see FinchAPI::Models::HRIS::IndividualInDirectory#manager + # @see FinchAPI::HRIS::IndividualInDirectory#manager class Manager < FinchAPI::Internal::Type::BaseModel # @!attribute id # A stable Finch `id` (UUID v4) for an individual in the company. diff --git a/lib/finch_api/models/hris/individual_response.rb b/lib/finch_api/models/hris/individual_response.rb index eea6bdc0..d0f24d0b 100644 --- a/lib/finch_api/models/hris/individual_response.rb +++ b/lib/finch_api/models/hris/individual_response.rb @@ -7,8 +7,8 @@ module HRIS class IndividualResponse < FinchAPI::Internal::Type::BaseModel # @!attribute body # - # @return [FinchAPI::Models::HRIS::Individual::UnionMember0, FinchAPI::Models::HRIS::Individual::BatchError] - required :body, union: -> { FinchAPI::Models::HRIS::Individual } + # @return [FinchAPI::HRIS::Individual::UnionMember0, FinchAPI::HRIS::Individual::BatchError] + required :body, union: -> { FinchAPI::HRIS::Individual } # @!attribute code # @@ -21,7 +21,7 @@ class IndividualResponse < FinchAPI::Internal::Type::BaseModel required :individual_id, String # @!method initialize(body:, code:, individual_id:) - # @param body [FinchAPI::Models::HRIS::Individual::UnionMember0, FinchAPI::Models::HRIS::Individual::BatchError] + # @param body [FinchAPI::HRIS::Individual::UnionMember0, FinchAPI::HRIS::Individual::BatchError] # @param code [Integer] # @param individual_id [String] end diff --git a/lib/finch_api/models/hris/individual_retrieve_many_params.rb b/lib/finch_api/models/hris/individual_retrieve_many_params.rb index 00a9f6d3..6abe1edc 100644 --- a/lib/finch_api/models/hris/individual_retrieve_many_params.rb +++ b/lib/finch_api/models/hris/individual_retrieve_many_params.rb @@ -10,18 +10,20 @@ class IndividualRetrieveManyParams < FinchAPI::Internal::Type::BaseModel # @!attribute options # - # @return [FinchAPI::Models::HRIS::IndividualRetrieveManyParams::Options, nil] - optional :options, -> { FinchAPI::Models::HRIS::IndividualRetrieveManyParams::Options }, nil?: true + # @return [FinchAPI::HRIS::IndividualRetrieveManyParams::Options, nil] + optional :options, -> { FinchAPI::HRIS::IndividualRetrieveManyParams::Options }, nil?: true # @!attribute requests # - # @return [Array, nil] + # @return [Array, nil] optional :requests, - -> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::Models::HRIS::IndividualRetrieveManyParams::Request] } + -> { + FinchAPI::Internal::Type::ArrayOf[FinchAPI::HRIS::IndividualRetrieveManyParams::Request] + } # @!method initialize(options: nil, requests: nil, request_options: {}) - # @param options [FinchAPI::Models::HRIS::IndividualRetrieveManyParams::Options, nil] - # @param requests [Array] + # @param options [FinchAPI::HRIS::IndividualRetrieveManyParams::Options, nil] + # @param requests [Array] # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}] class Options < FinchAPI::Internal::Type::BaseModel diff --git a/lib/finch_api/models/hris/pay_statement.rb b/lib/finch_api/models/hris/pay_statement.rb index 2d36f3b1..55ce6f66 100644 --- a/lib/finch_api/models/hris/pay_statement.rb +++ b/lib/finch_api/models/hris/pay_statement.rb @@ -7,30 +7,36 @@ class PayStatement < FinchAPI::Internal::Type::BaseModel # @!attribute earnings # The array of earnings objects associated with this pay statement # - # @return [Array, nil] + # @return [Array, nil] optional :earnings, - -> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::Models::HRIS::PayStatement::Earning, nil?: true] }, + -> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::HRIS::PayStatement::Earning, nil?: true] }, nil?: true # @!attribute employee_deductions # The array of deductions objects associated with this pay statement. # - # @return [Array, nil] + # @return [Array, nil] optional :employee_deductions, - -> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::Models::HRIS::PayStatement::EmployeeDeduction, nil?: true] }, + -> { + FinchAPI::Internal::Type::ArrayOf[FinchAPI::HRIS::PayStatement::EmployeeDeduction, + nil?: true] + }, nil?: true # @!attribute employer_contributions # - # @return [Array, nil] + # @return [Array, nil] optional :employer_contributions, - -> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::Models::HRIS::PayStatement::EmployerContribution, nil?: true] }, + -> { + FinchAPI::Internal::Type::ArrayOf[FinchAPI::HRIS::PayStatement::EmployerContribution, + nil?: true] + }, nil?: true # @!attribute gross_pay # - # @return [FinchAPI::Models::Money, nil] - optional :gross_pay, -> { FinchAPI::Models::Money }, nil?: true + # @return [FinchAPI::Money, nil] + optional :gross_pay, -> { FinchAPI::Money }, nil?: true # @!attribute individual_id # A stable Finch `id` (UUID v4) for an individual in the company @@ -40,21 +46,21 @@ class PayStatement < FinchAPI::Internal::Type::BaseModel # @!attribute net_pay # - # @return [FinchAPI::Models::Money, nil] - optional :net_pay, -> { FinchAPI::Models::Money }, nil?: true + # @return [FinchAPI::Money, nil] + optional :net_pay, -> { FinchAPI::Money }, nil?: true # @!attribute payment_method # The payment method. # - # @return [Symbol, FinchAPI::Models::HRIS::PayStatement::PaymentMethod, nil] - optional :payment_method, enum: -> { FinchAPI::Models::HRIS::PayStatement::PaymentMethod }, nil?: true + # @return [Symbol, FinchAPI::HRIS::PayStatement::PaymentMethod, nil] + optional :payment_method, enum: -> { FinchAPI::HRIS::PayStatement::PaymentMethod }, nil?: true # @!attribute taxes # The array of taxes objects associated with this pay statement. # - # @return [Array, nil] + # @return [Array, nil] optional :taxes, - -> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::Models::HRIS::PayStatement::Tax, nil?: true] }, + -> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::HRIS::PayStatement::Tax, nil?: true] }, nil?: true # @!attribute total_hours @@ -66,29 +72,29 @@ class PayStatement < FinchAPI::Internal::Type::BaseModel # @!attribute type # The type of the payment associated with the pay statement. # - # @return [Symbol, FinchAPI::Models::HRIS::PayStatement::Type, nil] - optional :type, enum: -> { FinchAPI::Models::HRIS::PayStatement::Type }, nil?: true + # @return [Symbol, FinchAPI::HRIS::PayStatement::Type, nil] + optional :type, enum: -> { FinchAPI::HRIS::PayStatement::Type }, nil?: true # @!method initialize(earnings: nil, employee_deductions: nil, employer_contributions: nil, gross_pay: nil, individual_id: nil, net_pay: nil, payment_method: nil, taxes: nil, total_hours: nil, type: nil) - # @param earnings [Array, nil] The array of earnings objects associated with this pay statement + # @param earnings [Array, nil] The array of earnings objects associated with this pay statement # - # @param employee_deductions [Array, nil] The array of deductions objects associated with this pay statement. + # @param employee_deductions [Array, nil] The array of deductions objects associated with this pay statement. # - # @param employer_contributions [Array, nil] + # @param employer_contributions [Array, nil] # - # @param gross_pay [FinchAPI::Models::Money, nil] + # @param gross_pay [FinchAPI::Money, nil] # # @param individual_id [String] A stable Finch `id` (UUID v4) for an individual in the company # - # @param net_pay [FinchAPI::Models::Money, nil] + # @param net_pay [FinchAPI::Money, nil] # - # @param payment_method [Symbol, FinchAPI::Models::HRIS::PayStatement::PaymentMethod, nil] The payment method. + # @param payment_method [Symbol, FinchAPI::HRIS::PayStatement::PaymentMethod, nil] The payment method. # - # @param taxes [Array, nil] The array of taxes objects associated with this pay statement. + # @param taxes [Array, nil] The array of taxes objects associated with this pay statement. # # @param total_hours [Float, nil] The number of hours worked for this pay period # - # @param type [Symbol, FinchAPI::Models::HRIS::PayStatement::Type, nil] The type of the payment associated with the pay statement. + # @param type [Symbol, FinchAPI::HRIS::PayStatement::Type, nil] The type of the payment associated with the pay statement. class Earning < FinchAPI::Internal::Type::BaseModel # @!attribute amount @@ -99,8 +105,8 @@ class Earning < FinchAPI::Internal::Type::BaseModel # @!attribute attributes # - # @return [FinchAPI::Models::HRIS::PayStatement::Earning::Attributes, nil] - optional :attributes, -> { FinchAPI::Models::HRIS::PayStatement::Earning::Attributes }, nil?: true + # @return [FinchAPI::HRIS::PayStatement::Earning::Attributes, nil] + optional :attributes, -> { FinchAPI::HRIS::PayStatement::Earning::Attributes }, nil?: true # @!attribute currency # The earnings currency code. @@ -124,59 +130,57 @@ class Earning < FinchAPI::Internal::Type::BaseModel # @!attribute type # The type of earning. # - # @return [Symbol, FinchAPI::Models::HRIS::PayStatement::Earning::Type, nil] - optional :type, enum: -> { FinchAPI::Models::HRIS::PayStatement::Earning::Type }, nil?: true + # @return [Symbol, FinchAPI::HRIS::PayStatement::Earning::Type, nil] + optional :type, enum: -> { FinchAPI::HRIS::PayStatement::Earning::Type }, nil?: true # @!method initialize(amount: nil, attributes: nil, currency: nil, hours: nil, name: nil, type: nil) # Some parameter documentations has been truncated, see - # {FinchAPI::Models::HRIS::PayStatement::Earning} for more details. + # {FinchAPI::HRIS::PayStatement::Earning} for more details. # # @param amount [Integer, nil] The earnings amount in cents. # - # @param attributes [FinchAPI::Models::HRIS::PayStatement::Earning::Attributes, nil] + # @param attributes [FinchAPI::HRIS::PayStatement::Earning::Attributes, nil] # # @param currency [String, nil] The earnings currency code. # # @param hours [Float, nil] The number of hours associated with this earning. (For salaried employees, this - # ... # # @param name [String, nil] The exact name of the deduction from the pay statement. # - # @param type [Symbol, FinchAPI::Models::HRIS::PayStatement::Earning::Type, nil] The type of earning. + # @param type [Symbol, FinchAPI::HRIS::PayStatement::Earning::Type, nil] The type of earning. - # @see FinchAPI::Models::HRIS::PayStatement::Earning#attributes + # @see FinchAPI::HRIS::PayStatement::Earning#attributes class Attributes < FinchAPI::Internal::Type::BaseModel # @!attribute metadata # - # @return [FinchAPI::Models::HRIS::PayStatement::Earning::Attributes::Metadata, nil] - optional :metadata, -> { FinchAPI::Models::HRIS::PayStatement::Earning::Attributes::Metadata } + # @return [FinchAPI::HRIS::PayStatement::Earning::Attributes::Metadata, nil] + optional :metadata, -> { FinchAPI::HRIS::PayStatement::Earning::Attributes::Metadata } # @!method initialize(metadata: nil) - # @param metadata [FinchAPI::Models::HRIS::PayStatement::Earning::Attributes::Metadata] + # @param metadata [FinchAPI::HRIS::PayStatement::Earning::Attributes::Metadata] - # @see FinchAPI::Models::HRIS::PayStatement::Earning::Attributes#metadata + # @see FinchAPI::HRIS::PayStatement::Earning::Attributes#metadata class Metadata < FinchAPI::Internal::Type::BaseModel # @!attribute metadata # 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.). # - # @return [Hash{Symbol=>Object}, nil] - optional :metadata, FinchAPI::Internal::Type::HashOf[FinchAPI::Internal::Type::Unknown] + # @return [Hash{Symbol=>Object, nil}, nil] + optional :metadata, + FinchAPI::Internal::Type::HashOf[FinchAPI::Internal::Type::Unknown, nil?: true] # @!method initialize(metadata: nil) # Some parameter documentations has been truncated, see - # {FinchAPI::Models::HRIS::PayStatement::Earning::Attributes::Metadata} for more - # details. + # {FinchAPI::HRIS::PayStatement::Earning::Attributes::Metadata} for more details. # - # @param metadata [Hash{Symbol=>Object}] The metadata to be attached to the entity by existing rules. It is a key-value p - # ... + # @param metadata [Hash{Symbol=>Object, nil}] The metadata to be attached to the entity by existing rules. It is a key-value p end end # The type of earning. # - # @see FinchAPI::Models::HRIS::PayStatement::Earning#type + # @see FinchAPI::HRIS::PayStatement::Earning#type module Type extend FinchAPI::Internal::Type::Enum @@ -208,10 +212,8 @@ class EmployeeDeduction < FinchAPI::Internal::Type::BaseModel # @!attribute attributes # - # @return [FinchAPI::Models::HRIS::PayStatement::EmployeeDeduction::Attributes, nil] - optional :attributes, - -> { FinchAPI::Models::HRIS::PayStatement::EmployeeDeduction::Attributes }, - nil?: true + # @return [FinchAPI::HRIS::PayStatement::EmployeeDeduction::Attributes, nil] + optional :attributes, -> { FinchAPI::HRIS::PayStatement::EmployeeDeduction::Attributes }, nil?: true # @!attribute currency # The deduction currency. @@ -234,13 +236,13 @@ class EmployeeDeduction < FinchAPI::Internal::Type::BaseModel # @!attribute type # Type of benefit. # - # @return [Symbol, FinchAPI::Models::HRIS::BenefitType, nil] - optional :type, enum: -> { FinchAPI::Models::HRIS::BenefitType }, nil?: true + # @return [Symbol, FinchAPI::HRIS::BenefitType, nil] + optional :type, enum: -> { FinchAPI::HRIS::BenefitType }, nil?: true # @!method initialize(amount: nil, attributes: nil, currency: nil, name: nil, pre_tax: nil, type: nil) # @param amount [Integer, nil] The deduction amount in cents. # - # @param attributes [FinchAPI::Models::HRIS::PayStatement::EmployeeDeduction::Attributes, nil] + # @param attributes [FinchAPI::HRIS::PayStatement::EmployeeDeduction::Attributes, nil] # # @param currency [String, nil] The deduction currency. # @@ -248,35 +250,35 @@ class EmployeeDeduction < FinchAPI::Internal::Type::BaseModel # # @param pre_tax [Boolean, nil] Boolean indicating if the deduction is pre-tax. # - # @param type [Symbol, FinchAPI::Models::HRIS::BenefitType, nil] Type of benefit. + # @param type [Symbol, FinchAPI::HRIS::BenefitType, nil] Type of benefit. - # @see FinchAPI::Models::HRIS::PayStatement::EmployeeDeduction#attributes + # @see FinchAPI::HRIS::PayStatement::EmployeeDeduction#attributes class Attributes < FinchAPI::Internal::Type::BaseModel # @!attribute metadata # - # @return [FinchAPI::Models::HRIS::PayStatement::EmployeeDeduction::Attributes::Metadata, nil] - optional :metadata, -> { FinchAPI::Models::HRIS::PayStatement::EmployeeDeduction::Attributes::Metadata } + # @return [FinchAPI::HRIS::PayStatement::EmployeeDeduction::Attributes::Metadata, nil] + optional :metadata, -> { FinchAPI::HRIS::PayStatement::EmployeeDeduction::Attributes::Metadata } # @!method initialize(metadata: nil) - # @param metadata [FinchAPI::Models::HRIS::PayStatement::EmployeeDeduction::Attributes::Metadata] + # @param metadata [FinchAPI::HRIS::PayStatement::EmployeeDeduction::Attributes::Metadata] - # @see FinchAPI::Models::HRIS::PayStatement::EmployeeDeduction::Attributes#metadata + # @see FinchAPI::HRIS::PayStatement::EmployeeDeduction::Attributes#metadata class Metadata < FinchAPI::Internal::Type::BaseModel # @!attribute metadata # 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.). # - # @return [Hash{Symbol=>Object}, nil] - optional :metadata, FinchAPI::Internal::Type::HashOf[FinchAPI::Internal::Type::Unknown] + # @return [Hash{Symbol=>Object, nil}, nil] + optional :metadata, + FinchAPI::Internal::Type::HashOf[FinchAPI::Internal::Type::Unknown, nil?: true] # @!method initialize(metadata: nil) # Some parameter documentations has been truncated, see - # {FinchAPI::Models::HRIS::PayStatement::EmployeeDeduction::Attributes::Metadata} - # for more details. + # {FinchAPI::HRIS::PayStatement::EmployeeDeduction::Attributes::Metadata} for more + # details. # - # @param metadata [Hash{Symbol=>Object}] The metadata to be attached to the entity by existing rules. It is a key-value p - # ... + # @param metadata [Hash{Symbol=>Object, nil}] The metadata to be attached to the entity by existing rules. It is a key-value p end end end @@ -290,9 +292,11 @@ class EmployerContribution < FinchAPI::Internal::Type::BaseModel # @!attribute attributes # - # @return [FinchAPI::Models::HRIS::PayStatement::EmployerContribution::Attributes, nil] + # @return [FinchAPI::HRIS::PayStatement::EmployerContribution::Attributes, nil] optional :attributes, - -> { FinchAPI::Models::HRIS::PayStatement::EmployerContribution::Attributes }, + -> { + FinchAPI::HRIS::PayStatement::EmployerContribution::Attributes + }, nil?: true # @!attribute currency @@ -310,55 +314,57 @@ class EmployerContribution < FinchAPI::Internal::Type::BaseModel # @!attribute type # Type of benefit. # - # @return [Symbol, FinchAPI::Models::HRIS::BenefitType, nil] - optional :type, enum: -> { FinchAPI::Models::HRIS::BenefitType }, nil?: true + # @return [Symbol, FinchAPI::HRIS::BenefitType, nil] + optional :type, enum: -> { FinchAPI::HRIS::BenefitType }, nil?: true # @!method initialize(amount: nil, attributes: nil, currency: nil, name: nil, type: nil) # @param amount [Integer, nil] The contribution amount in cents. # - # @param attributes [FinchAPI::Models::HRIS::PayStatement::EmployerContribution::Attributes, nil] + # @param attributes [FinchAPI::HRIS::PayStatement::EmployerContribution::Attributes, nil] # # @param currency [String, nil] The contribution currency. # # @param name [String, nil] The contribution name from the pay statement. # - # @param type [Symbol, FinchAPI::Models::HRIS::BenefitType, nil] Type of benefit. + # @param type [Symbol, FinchAPI::HRIS::BenefitType, nil] Type of benefit. - # @see FinchAPI::Models::HRIS::PayStatement::EmployerContribution#attributes + # @see FinchAPI::HRIS::PayStatement::EmployerContribution#attributes class Attributes < FinchAPI::Internal::Type::BaseModel # @!attribute metadata # - # @return [FinchAPI::Models::HRIS::PayStatement::EmployerContribution::Attributes::Metadata, nil] + # @return [FinchAPI::HRIS::PayStatement::EmployerContribution::Attributes::Metadata, nil] optional :metadata, - -> { FinchAPI::Models::HRIS::PayStatement::EmployerContribution::Attributes::Metadata } + -> { + FinchAPI::HRIS::PayStatement::EmployerContribution::Attributes::Metadata + } # @!method initialize(metadata: nil) - # @param metadata [FinchAPI::Models::HRIS::PayStatement::EmployerContribution::Attributes::Metadata] + # @param metadata [FinchAPI::HRIS::PayStatement::EmployerContribution::Attributes::Metadata] - # @see FinchAPI::Models::HRIS::PayStatement::EmployerContribution::Attributes#metadata + # @see FinchAPI::HRIS::PayStatement::EmployerContribution::Attributes#metadata class Metadata < FinchAPI::Internal::Type::BaseModel # @!attribute metadata # 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.). # - # @return [Hash{Symbol=>Object}, nil] - optional :metadata, FinchAPI::Internal::Type::HashOf[FinchAPI::Internal::Type::Unknown] + # @return [Hash{Symbol=>Object, nil}, nil] + optional :metadata, + FinchAPI::Internal::Type::HashOf[FinchAPI::Internal::Type::Unknown, nil?: true] # @!method initialize(metadata: nil) # Some parameter documentations has been truncated, see - # {FinchAPI::Models::HRIS::PayStatement::EmployerContribution::Attributes::Metadata} - # for more details. + # {FinchAPI::HRIS::PayStatement::EmployerContribution::Attributes::Metadata} for + # more details. # - # @param metadata [Hash{Symbol=>Object}] The metadata to be attached to the entity by existing rules. It is a key-value p - # ... + # @param metadata [Hash{Symbol=>Object, nil}] The metadata to be attached to the entity by existing rules. It is a key-value p end end end # The payment method. # - # @see FinchAPI::Models::HRIS::PayStatement#payment_method + # @see FinchAPI::HRIS::PayStatement#payment_method module PaymentMethod extend FinchAPI::Internal::Type::Enum @@ -378,8 +384,8 @@ class Tax < FinchAPI::Internal::Type::BaseModel # @!attribute attributes # - # @return [FinchAPI::Models::HRIS::PayStatement::Tax::Attributes, nil] - optional :attributes, -> { FinchAPI::Models::HRIS::PayStatement::Tax::Attributes }, nil?: true + # @return [FinchAPI::HRIS::PayStatement::Tax::Attributes, nil] + optional :attributes, -> { FinchAPI::HRIS::PayStatement::Tax::Attributes }, nil?: true # @!attribute currency # The currency code. @@ -402,13 +408,13 @@ class Tax < FinchAPI::Internal::Type::BaseModel # @!attribute type # The type of taxes. # - # @return [Symbol, FinchAPI::Models::HRIS::PayStatement::Tax::Type, nil] - optional :type, enum: -> { FinchAPI::Models::HRIS::PayStatement::Tax::Type }, nil?: true + # @return [Symbol, FinchAPI::HRIS::PayStatement::Tax::Type, nil] + optional :type, enum: -> { FinchAPI::HRIS::PayStatement::Tax::Type }, nil?: true # @!method initialize(amount: nil, attributes: nil, currency: nil, employer: nil, name: nil, type: nil) # @param amount [Integer, nil] The tax amount in cents. # - # @param attributes [FinchAPI::Models::HRIS::PayStatement::Tax::Attributes, nil] + # @param attributes [FinchAPI::HRIS::PayStatement::Tax::Attributes, nil] # # @param currency [String, nil] The currency code. # @@ -416,41 +422,40 @@ class Tax < FinchAPI::Internal::Type::BaseModel # # @param name [String, nil] The exact name of tax from the pay statement. # - # @param type [Symbol, FinchAPI::Models::HRIS::PayStatement::Tax::Type, nil] The type of taxes. + # @param type [Symbol, FinchAPI::HRIS::PayStatement::Tax::Type, nil] The type of taxes. - # @see FinchAPI::Models::HRIS::PayStatement::Tax#attributes + # @see FinchAPI::HRIS::PayStatement::Tax#attributes class Attributes < FinchAPI::Internal::Type::BaseModel # @!attribute metadata # - # @return [FinchAPI::Models::HRIS::PayStatement::Tax::Attributes::Metadata, nil] - optional :metadata, -> { FinchAPI::Models::HRIS::PayStatement::Tax::Attributes::Metadata } + # @return [FinchAPI::HRIS::PayStatement::Tax::Attributes::Metadata, nil] + optional :metadata, -> { FinchAPI::HRIS::PayStatement::Tax::Attributes::Metadata } # @!method initialize(metadata: nil) - # @param metadata [FinchAPI::Models::HRIS::PayStatement::Tax::Attributes::Metadata] + # @param metadata [FinchAPI::HRIS::PayStatement::Tax::Attributes::Metadata] - # @see FinchAPI::Models::HRIS::PayStatement::Tax::Attributes#metadata + # @see FinchAPI::HRIS::PayStatement::Tax::Attributes#metadata class Metadata < FinchAPI::Internal::Type::BaseModel # @!attribute metadata # 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.). # - # @return [Hash{Symbol=>Object}, nil] - optional :metadata, FinchAPI::Internal::Type::HashOf[FinchAPI::Internal::Type::Unknown] + # @return [Hash{Symbol=>Object, nil}, nil] + optional :metadata, + FinchAPI::Internal::Type::HashOf[FinchAPI::Internal::Type::Unknown, nil?: true] # @!method initialize(metadata: nil) # Some parameter documentations has been truncated, see - # {FinchAPI::Models::HRIS::PayStatement::Tax::Attributes::Metadata} for more - # details. + # {FinchAPI::HRIS::PayStatement::Tax::Attributes::Metadata} for more details. # - # @param metadata [Hash{Symbol=>Object}] The metadata to be attached to the entity by existing rules. It is a key-value p - # ... + # @param metadata [Hash{Symbol=>Object, nil}] The metadata to be attached to the entity by existing rules. It is a key-value p end end # The type of taxes. # - # @see FinchAPI::Models::HRIS::PayStatement::Tax#type + # @see FinchAPI::HRIS::PayStatement::Tax#type module Type extend FinchAPI::Internal::Type::Enum @@ -466,7 +471,7 @@ module Type # The type of the payment associated with the pay statement. # - # @see FinchAPI::Models::HRIS::PayStatement#type + # @see FinchAPI::HRIS::PayStatement#type module Type extend FinchAPI::Internal::Type::Enum diff --git a/lib/finch_api/models/hris/pay_statement_response.rb b/lib/finch_api/models/hris/pay_statement_response.rb index b2449a2c..7824a0dd 100644 --- a/lib/finch_api/models/hris/pay_statement_response.rb +++ b/lib/finch_api/models/hris/pay_statement_response.rb @@ -7,8 +7,8 @@ module HRIS class PayStatementResponse < FinchAPI::Internal::Type::BaseModel # @!attribute body # - # @return [FinchAPI::Models::HRIS::PayStatementResponseBody, nil] - optional :body, -> { FinchAPI::Models::HRIS::PayStatementResponseBody } + # @return [FinchAPI::HRIS::PayStatementResponseBody, nil] + optional :body, -> { FinchAPI::HRIS::PayStatementResponseBody } # @!attribute code # @@ -21,7 +21,7 @@ class PayStatementResponse < FinchAPI::Internal::Type::BaseModel optional :payment_id, String # @!method initialize(body: nil, code: nil, payment_id: nil) - # @param body [FinchAPI::Models::HRIS::PayStatementResponseBody] + # @param body [FinchAPI::HRIS::PayStatementResponseBody] # @param code [Integer] # @param payment_id [String] end diff --git a/lib/finch_api/models/hris/pay_statement_response_body.rb b/lib/finch_api/models/hris/pay_statement_response_body.rb index f75da51c..a4048715 100644 --- a/lib/finch_api/models/hris/pay_statement_response_body.rb +++ b/lib/finch_api/models/hris/pay_statement_response_body.rb @@ -6,19 +6,19 @@ module HRIS class PayStatementResponseBody < FinchAPI::Internal::Type::BaseModel # @!attribute paging # - # @return [FinchAPI::Models::Paging, nil] - optional :paging, -> { FinchAPI::Models::Paging } + # @return [FinchAPI::Paging, nil] + optional :paging, -> { FinchAPI::Paging } # @!attribute pay_statements # The array of pay statements for the current payment. # - # @return [Array, nil] - optional :pay_statements, -> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::Models::HRIS::PayStatement] } + # @return [Array, nil] + optional :pay_statements, -> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::HRIS::PayStatement] } # @!method initialize(paging: nil, pay_statements: nil) - # @param paging [FinchAPI::Models::Paging] + # @param paging [FinchAPI::Paging] # - # @param pay_statements [Array] The array of pay statements for the current payment. + # @param pay_statements [Array] The array of pay statements for the current payment. end end end diff --git a/lib/finch_api/models/hris/pay_statement_retrieve_many_params.rb b/lib/finch_api/models/hris/pay_statement_retrieve_many_params.rb index 2d3ef084..b7154eb0 100644 --- a/lib/finch_api/models/hris/pay_statement_retrieve_many_params.rb +++ b/lib/finch_api/models/hris/pay_statement_retrieve_many_params.rb @@ -11,12 +11,14 @@ class PayStatementRetrieveManyParams < FinchAPI::Internal::Type::BaseModel # @!attribute requests # The array of batch requests. # - # @return [Array] + # @return [Array] required :requests, - -> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::Models::HRIS::PayStatementRetrieveManyParams::Request] } + -> { + FinchAPI::Internal::Type::ArrayOf[FinchAPI::HRIS::PayStatementRetrieveManyParams::Request] + } # @!method initialize(requests:, request_options: {}) - # @param requests [Array] The array of batch requests. + # @param requests [Array] The array of batch requests. # # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}] diff --git a/lib/finch_api/models/hris/payment.rb b/lib/finch_api/models/hris/payment.rb index 52787aae..e95d8923 100644 --- a/lib/finch_api/models/hris/payment.rb +++ b/lib/finch_api/models/hris/payment.rb @@ -13,8 +13,8 @@ class Payment < FinchAPI::Internal::Type::BaseModel # @!attribute company_debit # - # @return [FinchAPI::Models::Money, nil] - optional :company_debit, -> { FinchAPI::Models::Money }, nil?: true + # @return [FinchAPI::Money, nil] + optional :company_debit, -> { FinchAPI::Money }, nil?: true # @!attribute debit_date # @@ -23,18 +23,18 @@ class Payment < FinchAPI::Internal::Type::BaseModel # @!attribute employee_taxes # - # @return [FinchAPI::Models::Money, nil] - optional :employee_taxes, -> { FinchAPI::Models::Money }, nil?: true + # @return [FinchAPI::Money, nil] + optional :employee_taxes, -> { FinchAPI::Money }, nil?: true # @!attribute employer_taxes # - # @return [FinchAPI::Models::Money, nil] - optional :employer_taxes, -> { FinchAPI::Models::Money }, nil?: true + # @return [FinchAPI::Money, nil] + optional :employer_taxes, -> { FinchAPI::Money }, nil?: true # @!attribute gross_pay # - # @return [FinchAPI::Models::Money, nil] - optional :gross_pay, -> { FinchAPI::Models::Money }, nil?: true + # @return [FinchAPI::Money, nil] + optional :gross_pay, -> { FinchAPI::Money }, nil?: true # @!attribute individual_ids # Array of every individual on this payment. @@ -44,8 +44,8 @@ class Payment < FinchAPI::Internal::Type::BaseModel # @!attribute net_pay # - # @return [FinchAPI::Models::Money, nil] - optional :net_pay, -> { FinchAPI::Models::Money }, nil?: true + # @return [FinchAPI::Money, nil] + optional :net_pay, -> { FinchAPI::Money }, nil?: true # @!attribute pay_date # @@ -55,9 +55,9 @@ class Payment < FinchAPI::Internal::Type::BaseModel # @!attribute pay_frequencies # List of pay frequencies associated with this payment. # - # @return [Array, nil] + # @return [Array, nil] optional :pay_frequencies, - -> { FinchAPI::Internal::Type::ArrayOf[enum: FinchAPI::Models::HRIS::Payment::PayFrequency] }, + -> { FinchAPI::Internal::Type::ArrayOf[enum: FinchAPI::HRIS::Payment::PayFrequency] }, nil?: true # @!attribute pay_group_ids @@ -69,33 +69,33 @@ class Payment < FinchAPI::Internal::Type::BaseModel # @!attribute pay_period # The pay period object. # - # @return [FinchAPI::Models::HRIS::Payment::PayPeriod, nil] - optional :pay_period, -> { FinchAPI::Models::HRIS::Payment::PayPeriod }, nil?: true + # @return [FinchAPI::HRIS::Payment::PayPeriod, nil] + optional :pay_period, -> { FinchAPI::HRIS::Payment::PayPeriod }, nil?: true # @!method initialize(id: nil, company_debit: nil, debit_date: nil, employee_taxes: nil, employer_taxes: nil, gross_pay: nil, individual_ids: nil, net_pay: nil, pay_date: nil, pay_frequencies: nil, pay_group_ids: nil, pay_period: nil) # @param id [String] The unique id for the payment. # - # @param company_debit [FinchAPI::Models::Money, nil] + # @param company_debit [FinchAPI::Money, nil] # # @param debit_date [String, nil] # - # @param employee_taxes [FinchAPI::Models::Money, nil] + # @param employee_taxes [FinchAPI::Money, nil] # - # @param employer_taxes [FinchAPI::Models::Money, nil] + # @param employer_taxes [FinchAPI::Money, nil] # - # @param gross_pay [FinchAPI::Models::Money, nil] + # @param gross_pay [FinchAPI::Money, nil] # # @param individual_ids [Array, nil] Array of every individual on this payment. # - # @param net_pay [FinchAPI::Models::Money, nil] + # @param net_pay [FinchAPI::Money, nil] # # @param pay_date [String, nil] # - # @param pay_frequencies [Array, nil] List of pay frequencies associated with this payment. + # @param pay_frequencies [Array, nil] List of pay frequencies associated with this payment. # # @param pay_group_ids [Array, nil] Array of the Finch id (uuidv4) of every pay group associated with this payment. # - # @param pay_period [FinchAPI::Models::HRIS::Payment::PayPeriod, nil] The pay period object. + # @param pay_period [FinchAPI::HRIS::Payment::PayPeriod, nil] The pay period object. module PayFrequency extend FinchAPI::Internal::Type::Enum @@ -114,7 +114,7 @@ module PayFrequency # @return [Array] end - # @see FinchAPI::Models::HRIS::Payment#pay_period + # @see FinchAPI::HRIS::Payment#pay_period class PayPeriod < FinchAPI::Internal::Type::BaseModel # @!attribute end_date # diff --git a/lib/finch_api/models/hris/payment_list_params.rb b/lib/finch_api/models/hris/payment_list_params.rb index e9d5eeff..7e55bd53 100644 --- a/lib/finch_api/models/hris/payment_list_params.rb +++ b/lib/finch_api/models/hris/payment_list_params.rb @@ -27,10 +27,8 @@ class PaymentListParams < FinchAPI::Internal::Type::BaseModel # {FinchAPI::Models::HRIS::PaymentListParams} for more details. # # @param end_date [Date] The end date to retrieve payments by a company (inclusive) in `YYYY-MM-DD` forma - # ... # # @param start_date [Date] The start date to retrieve payments by a company (inclusive) in `YYYY-MM-DD` for - # ... # # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}] end diff --git a/lib/finch_api/models/hris/support_per_benefit_type.rb b/lib/finch_api/models/hris/support_per_benefit_type.rb index d477263c..53105f59 100644 --- a/lib/finch_api/models/hris/support_per_benefit_type.rb +++ b/lib/finch_api/models/hris/support_per_benefit_type.rb @@ -6,17 +6,17 @@ module HRIS class SupportPerBenefitType < FinchAPI::Internal::Type::BaseModel # @!attribute company_benefits # - # @return [FinchAPI::Models::OperationSupportMatrix, nil] - optional :company_benefits, -> { FinchAPI::Models::OperationSupportMatrix } + # @return [FinchAPI::OperationSupportMatrix, nil] + optional :company_benefits, -> { FinchAPI::OperationSupportMatrix } # @!attribute individual_benefits # - # @return [FinchAPI::Models::OperationSupportMatrix, nil] - optional :individual_benefits, -> { FinchAPI::Models::OperationSupportMatrix } + # @return [FinchAPI::OperationSupportMatrix, nil] + optional :individual_benefits, -> { FinchAPI::OperationSupportMatrix } # @!method initialize(company_benefits: nil, individual_benefits: nil) - # @param company_benefits [FinchAPI::Models::OperationSupportMatrix] - # @param individual_benefits [FinchAPI::Models::OperationSupportMatrix] + # @param company_benefits [FinchAPI::OperationSupportMatrix] + # @param individual_benefits [FinchAPI::OperationSupportMatrix] end end end diff --git a/lib/finch_api/models/hris/supported_benefit.rb b/lib/finch_api/models/hris/supported_benefit.rb index 03bf35e3..b610b62d 100644 --- a/lib/finch_api/models/hris/supported_benefit.rb +++ b/lib/finch_api/models/hris/supported_benefit.rb @@ -21,9 +21,12 @@ class SupportedBenefit < FinchAPI::Internal::Type::BaseModel # Supported contribution types. An empty array indicates contributions are not # supported. # - # @return [Array, nil] + # @return [Array, nil] optional :company_contribution, - -> { FinchAPI::Internal::Type::ArrayOf[enum: FinchAPI::Models::HRIS::SupportedBenefit::CompanyContribution, nil?: true] }, + -> { + FinchAPI::Internal::Type::ArrayOf[enum: FinchAPI::HRIS::SupportedBenefit::CompanyContribution, + nil?: true] + }, nil?: true # @!attribute description @@ -35,48 +38,50 @@ class SupportedBenefit < FinchAPI::Internal::Type::BaseModel # Supported deduction types. An empty array indicates deductions are not # supported. # - # @return [Array, nil] + # @return [Array, nil] optional :employee_deduction, - -> { FinchAPI::Internal::Type::ArrayOf[enum: FinchAPI::Models::HRIS::SupportedBenefit::EmployeeDeduction, nil?: true] }, + -> { + FinchAPI::Internal::Type::ArrayOf[enum: FinchAPI::HRIS::SupportedBenefit::EmployeeDeduction, + nil?: true] + }, nil?: true # @!attribute frequencies # The list of frequencies supported by the provider for this benefit # - # @return [Array, nil] + # @return [Array, nil] optional :frequencies, - -> { FinchAPI::Internal::Type::ArrayOf[enum: FinchAPI::Models::HRIS::BenefitFrequency, nil?: true] } + -> { FinchAPI::Internal::Type::ArrayOf[enum: FinchAPI::HRIS::BenefitFrequency, nil?: true] } # @!attribute hsa_contribution_limit # 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. # - # @return [Array, nil] + # @return [Array, nil] optional :hsa_contribution_limit, - -> { FinchAPI::Internal::Type::ArrayOf[enum: FinchAPI::Models::HRIS::SupportedBenefit::HsaContributionLimit, nil?: true] }, + -> { + FinchAPI::Internal::Type::ArrayOf[enum: FinchAPI::HRIS::SupportedBenefit::HsaContributionLimit, + nil?: true] + }, nil?: true # @!method initialize(annual_maximum: nil, catch_up: nil, company_contribution: nil, description: nil, employee_deduction: nil, frequencies: nil, hsa_contribution_limit: nil) # Some parameter documentations has been truncated, see - # {FinchAPI::Models::HRIS::SupportedBenefit} for more details. + # {FinchAPI::HRIS::SupportedBenefit} for more details. # # @param annual_maximum [Boolean, nil] Whether the provider supports an annual maximum for this benefit. # # @param catch_up [Boolean, nil] Whether the provider supports catch up for this benefit. This field will only be - # ... # - # @param company_contribution [Array, nil] Supported contribution types. An empty array indicates contributions are not sup - # ... + # @param company_contribution [Array, nil] Supported contribution types. An empty array indicates contributions are not sup # # @param description [String, nil] # - # @param employee_deduction [Array, nil] Supported deduction types. An empty array indicates deductions are not supported - # ... + # @param employee_deduction [Array, nil] Supported deduction types. An empty array indicates deductions are not supported # - # @param frequencies [Array] The list of frequencies supported by the provider for this benefit + # @param frequencies [Array] The list of frequencies supported by the provider for this benefit # - # @param hsa_contribution_limit [Array, nil] Whether the provider supports HSA contribution limits. Empty if this feature is - # ... + # @param hsa_contribution_limit [Array, nil] Whether the provider supports HSA contribution limits. Empty if this feature is module CompanyContribution extend FinchAPI::Internal::Type::Enum diff --git a/lib/finch_api/models/hris/w42005.rb b/lib/finch_api/models/hris/w42005.rb index 63bae18f..79f5aa99 100644 --- a/lib/finch_api/models/hris/w42005.rb +++ b/lib/finch_api/models/hris/w42005.rb @@ -7,14 +7,14 @@ class W42005 < FinchAPI::Internal::Type::BaseModel # @!attribute data # Detailed information specific to the 2005 W4 form. # - # @return [FinchAPI::Models::HRIS::W42005::Data, nil] - optional :data, -> { FinchAPI::Models::HRIS::W42005::Data } + # @return [FinchAPI::HRIS::W42005::Data, nil] + optional :data, -> { FinchAPI::HRIS::W42005::Data } # @!attribute type # Specifies the form type, indicating that this document is a 2005 W4 form. # - # @return [Symbol, FinchAPI::Models::HRIS::W42005::Type, nil] - optional :type, enum: -> { FinchAPI::Models::HRIS::W42005::Type } + # @return [Symbol, FinchAPI::HRIS::W42005::Type, nil] + optional :type, enum: -> { FinchAPI::HRIS::W42005::Type } # @!attribute year # The tax year this W4 document applies to. @@ -26,13 +26,13 @@ class W42005 < FinchAPI::Internal::Type::BaseModel # A 2005 version of the W-4 tax form containing information on an individual's # filing status, dependents, and withholding details. # - # @param data [FinchAPI::Models::HRIS::W42005::Data] Detailed information specific to the 2005 W4 form. + # @param data [FinchAPI::HRIS::W42005::Data] Detailed information specific to the 2005 W4 form. # - # @param type [Symbol, FinchAPI::Models::HRIS::W42005::Type] Specifies the form type, indicating that this document is a 2005 W4 form. + # @param type [Symbol, FinchAPI::HRIS::W42005::Type] Specifies the form type, indicating that this document is a 2005 W4 form. # # @param year [Float, nil] The tax year this W4 document applies to. - # @see FinchAPI::Models::HRIS::W42005#data + # @see FinchAPI::HRIS::W42005#data class Data < FinchAPI::Internal::Type::BaseModel # @!attribute additional_withholding # Additional withholding amount (in cents). @@ -43,14 +43,14 @@ class Data < FinchAPI::Internal::Type::BaseModel # @!attribute exemption # Indicates exemption status from federal tax withholding. # - # @return [Symbol, FinchAPI::Models::HRIS::W42005::Data::Exemption, nil] - optional :exemption, enum: -> { FinchAPI::Models::HRIS::W42005::Data::Exemption } + # @return [Symbol, FinchAPI::HRIS::W42005::Data::Exemption, nil] + optional :exemption, enum: -> { FinchAPI::HRIS::W42005::Data::Exemption } # @!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 }, nil?: true + # @return [Symbol, FinchAPI::HRIS::W42005::Data::FilingStatus, nil] + optional :filing_status, enum: -> { FinchAPI::HRIS::W42005::Data::FilingStatus }, nil?: true # @!attribute individual_id # The unique identifier for the individual associated with this 2005 W4 form. @@ -69,9 +69,9 @@ class Data < FinchAPI::Internal::Type::BaseModel # # @param additional_withholding [Integer, nil] Additional withholding amount (in cents). # - # @param exemption [Symbol, FinchAPI::Models::HRIS::W42005::Data::Exemption] Indicates exemption status from federal tax withholding. + # @param exemption [Symbol, FinchAPI::HRIS::W42005::Data::Exemption] Indicates exemption status from federal tax withholding. # - # @param filing_status [Symbol, FinchAPI::Models::HRIS::W42005::Data::FilingStatus, nil] The individual's filing status for tax purposes. + # @param filing_status [Symbol, FinchAPI::HRIS::W42005::Data::FilingStatus, nil] The individual's filing status for tax purposes. # # @param individual_id [String] The unique identifier for the individual associated with this 2005 W4 form. # @@ -79,7 +79,7 @@ class Data < FinchAPI::Internal::Type::BaseModel # Indicates exemption status from federal tax withholding. # - # @see FinchAPI::Models::HRIS::W42005::Data#exemption + # @see FinchAPI::HRIS::W42005::Data#exemption module Exemption extend FinchAPI::Internal::Type::Enum @@ -92,7 +92,7 @@ module Exemption # The individual's filing status for tax purposes. # - # @see FinchAPI::Models::HRIS::W42005::Data#filing_status + # @see FinchAPI::HRIS::W42005::Data#filing_status module FilingStatus extend FinchAPI::Internal::Type::Enum @@ -107,7 +107,7 @@ module FilingStatus # Specifies the form type, indicating that this document is a 2005 W4 form. # - # @see FinchAPI::Models::HRIS::W42005#type + # @see FinchAPI::HRIS::W42005#type module Type extend FinchAPI::Internal::Type::Enum diff --git a/lib/finch_api/models/hris/w42020.rb b/lib/finch_api/models/hris/w42020.rb index 4aa9af3a..f4b014f4 100644 --- a/lib/finch_api/models/hris/w42020.rb +++ b/lib/finch_api/models/hris/w42020.rb @@ -7,14 +7,14 @@ class W42020 < FinchAPI::Internal::Type::BaseModel # @!attribute data # Detailed information specific to the 2020 W4 form. # - # @return [FinchAPI::Models::HRIS::W42020::Data, nil] - optional :data, -> { FinchAPI::Models::HRIS::W42020::Data } + # @return [FinchAPI::HRIS::W42020::Data, nil] + optional :data, -> { FinchAPI::HRIS::W42020::Data } # @!attribute type # Specifies the form type, indicating that this document is a 2020 W4 form. # - # @return [Symbol, FinchAPI::Models::HRIS::W42020::Type, nil] - optional :type, enum: -> { FinchAPI::Models::HRIS::W42020::Type } + # @return [Symbol, FinchAPI::HRIS::W42020::Type, nil] + optional :type, enum: -> { FinchAPI::HRIS::W42020::Type } # @!attribute year # The tax year this W4 document applies to. @@ -26,13 +26,13 @@ class W42020 < FinchAPI::Internal::Type::BaseModel # A 2020 version of the W-4 tax form containing information on an individual's # filing status, dependents, and withholding details. # - # @param data [FinchAPI::Models::HRIS::W42020::Data] Detailed information specific to the 2020 W4 form. + # @param data [FinchAPI::HRIS::W42020::Data] Detailed information specific to the 2020 W4 form. # - # @param type [Symbol, FinchAPI::Models::HRIS::W42020::Type] Specifies the form type, indicating that this document is a 2020 W4 form. + # @param type [Symbol, FinchAPI::HRIS::W42020::Type] Specifies the form type, indicating that this document is a 2020 W4 form. # # @param year [Float, nil] The tax year this W4 document applies to. - # @see FinchAPI::Models::HRIS::W42020#data + # @see FinchAPI::HRIS::W42020#data class Data < FinchAPI::Internal::Type::BaseModel # @!attribute amount_for_other_dependents # Amount claimed for dependents other than qualifying children under 17 (in @@ -62,8 +62,8 @@ class Data < FinchAPI::Internal::Type::BaseModel # @!attribute filing_status # The individual's filing status for tax purposes. # - # @return [Symbol, FinchAPI::Models::HRIS::W42020::Data::FilingStatus, nil] - optional :filing_status, enum: -> { FinchAPI::Models::HRIS::W42020::Data::FilingStatus }, nil?: true + # @return [Symbol, FinchAPI::HRIS::W42020::Data::FilingStatus, nil] + optional :filing_status, enum: -> { FinchAPI::HRIS::W42020::Data::FilingStatus }, nil?: true # @!attribute individual_id # The unique identifier for the individual associated with this document. @@ -85,12 +85,11 @@ class Data < FinchAPI::Internal::Type::BaseModel # @!method initialize(amount_for_other_dependents: nil, amount_for_qualifying_children_under_17: nil, deductions: nil, extra_withholding: nil, filing_status: nil, individual_id: nil, other_income: nil, total_claim_dependent_and_other_credits: nil) # Some parameter documentations has been truncated, see - # {FinchAPI::Models::HRIS::W42020::Data} for more details. + # {FinchAPI::HRIS::W42020::Data} for more details. # # Detailed information specific to the 2020 W4 form. # # @param amount_for_other_dependents [Integer, nil] Amount claimed for dependents other than qualifying children under 17 (in cents) - # ... # # @param amount_for_qualifying_children_under_17 [Integer, nil] Amount claimed for dependents under 17 years old (in cents). # @@ -98,7 +97,7 @@ class Data < FinchAPI::Internal::Type::BaseModel # # @param extra_withholding [Integer, nil] Additional withholding amount (in cents). # - # @param filing_status [Symbol, FinchAPI::Models::HRIS::W42020::Data::FilingStatus, nil] The individual's filing status for tax purposes. + # @param filing_status [Symbol, FinchAPI::HRIS::W42020::Data::FilingStatus, nil] The individual's filing status for tax purposes. # # @param individual_id [String] The unique identifier for the individual associated with this document. # @@ -108,7 +107,7 @@ class Data < FinchAPI::Internal::Type::BaseModel # The individual's filing status for tax purposes. # - # @see FinchAPI::Models::HRIS::W42020::Data#filing_status + # @see FinchAPI::HRIS::W42020::Data#filing_status module FilingStatus extend FinchAPI::Internal::Type::Enum @@ -124,7 +123,7 @@ module FilingStatus # Specifies the form type, indicating that this document is a 2020 W4 form. # - # @see FinchAPI::Models::HRIS::W42020#type + # @see FinchAPI::HRIS::W42020#type module Type extend FinchAPI::Internal::Type::Enum diff --git a/lib/finch_api/models/income.rb b/lib/finch_api/models/income.rb index a5242cd6..044ba2ac 100644 --- a/lib/finch_api/models/income.rb +++ b/lib/finch_api/models/income.rb @@ -7,30 +7,30 @@ class Income < FinchAPI::Internal::Type::BaseModel # The income amount in cents. # # @return [Integer, nil] - optional :amount, Integer, nil?: true + required :amount, Integer, nil?: true # @!attribute currency # The currency code. # # @return [String, nil] - optional :currency, String, nil?: true + required :currency, String, nil?: true # @!attribute effective_date # The date the income amount went into effect. # # @return [String, nil] - optional :effective_date, String, nil?: true + required :effective_date, String, nil?: true # @!attribute unit # The income unit of payment. Options: `yearly`, `quarterly`, `monthly`, # `semi_monthly`, `bi_weekly`, `weekly`, `daily`, `hourly`, and `fixed`. # - # @return [Symbol, FinchAPI::Models::Income::Unit, nil] - optional :unit, enum: -> { FinchAPI::Models::Income::Unit }, nil?: true + # @return [Symbol, FinchAPI::Income::Unit, nil] + required :unit, enum: -> { FinchAPI::Income::Unit }, nil?: true - # @!method initialize(amount: nil, currency: nil, effective_date: nil, unit: nil) - # Some parameter documentations has been truncated, see {FinchAPI::Models::Income} - # for more details. + # @!method initialize(amount:, currency:, effective_date:, unit:) + # Some parameter documentations has been truncated, see {FinchAPI::Income} for + # more details. # # 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, @@ -42,13 +42,12 @@ class Income < FinchAPI::Internal::Type::BaseModel # # @param effective_date [String, nil] The date the income amount went into effect. # - # @param unit [Symbol, FinchAPI::Models::Income::Unit, nil] The income unit of payment. Options: `yearly`, `quarterly`, `monthly`, `semi_mon - # ... + # @param unit [Symbol, FinchAPI::Income::Unit, nil] The income unit of payment. Options: `yearly`, `quarterly`, `monthly`, `semi_mon # The income unit of payment. Options: `yearly`, `quarterly`, `monthly`, # `semi_monthly`, `bi_weekly`, `weekly`, `daily`, `hourly`, and `fixed`. # - # @see FinchAPI::Models::Income#unit + # @see FinchAPI::Income#unit module Unit extend FinchAPI::Internal::Type::Enum diff --git a/lib/finch_api/models/individual_event.rb b/lib/finch_api/models/individual_event.rb index 5eaf3eb4..38fededd 100644 --- a/lib/finch_api/models/individual_event.rb +++ b/lib/finch_api/models/individual_event.rb @@ -5,17 +5,17 @@ module Models class IndividualEvent < FinchAPI::Models::BaseWebhookEvent # @!attribute data # - # @return [FinchAPI::Models::IndividualEvent::Data, nil] - optional :data, -> { FinchAPI::Models::IndividualEvent::Data } + # @return [FinchAPI::IndividualEvent::Data, nil] + optional :data, -> { FinchAPI::IndividualEvent::Data } # @!attribute event_type # - # @return [Symbol, FinchAPI::Models::IndividualEvent::EventType, nil] - optional :event_type, enum: -> { FinchAPI::Models::IndividualEvent::EventType } + # @return [Symbol, FinchAPI::IndividualEvent::EventType, nil] + optional :event_type, enum: -> { FinchAPI::IndividualEvent::EventType } # @!method initialize(data: nil, event_type: nil) - # @param data [FinchAPI::Models::IndividualEvent::Data] - # @param event_type [Symbol, FinchAPI::Models::IndividualEvent::EventType] + # @param data [FinchAPI::IndividualEvent::Data] + # @param event_type [Symbol, FinchAPI::IndividualEvent::EventType] class Data < FinchAPI::Internal::Type::BaseModel # @!attribute individual_id diff --git a/lib/finch_api/models/introspection.rb b/lib/finch_api/models/introspection.rb index dfc705b2..b4805cae 100644 --- a/lib/finch_api/models/introspection.rb +++ b/lib/finch_api/models/introspection.rb @@ -21,9 +21,9 @@ class Introspection < FinchAPI::Internal::Type::BaseModel # @!attribute authentication_methods # - # @return [Array] + # @return [Array] required :authentication_methods, - -> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::Models::Introspection::AuthenticationMethod] } + -> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::Introspection::AuthenticationMethod] } # @!attribute client_id # The client ID of the application associated with the `access_token`. @@ -34,8 +34,8 @@ class Introspection < FinchAPI::Internal::Type::BaseModel # @!attribute client_type # The type of application associated with a token. # - # @return [Symbol, FinchAPI::Models::Introspection::ClientType] - required :client_type, enum: -> { FinchAPI::Models::Introspection::ClientType } + # @return [Symbol, FinchAPI::Introspection::ClientType] + required :client_type, enum: -> { FinchAPI::Introspection::ClientType } # @!attribute company_id # @deprecated @@ -54,8 +54,8 @@ class Introspection < FinchAPI::Internal::Type::BaseModel # @!attribute connection_status # - # @return [FinchAPI::Models::Introspection::ConnectionStatus] - required :connection_status, -> { FinchAPI::Models::Introspection::ConnectionStatus } + # @return [FinchAPI::Introspection::ConnectionStatus] + required :connection_status, -> { FinchAPI::Introspection::ConnectionStatus } # @!attribute connection_type # The type of the connection associated with the token. @@ -63,8 +63,8 @@ class Introspection < FinchAPI::Internal::Type::BaseModel # - `provider` - connection to an external provider # - `finch` - finch-generated data. # - # @return [Symbol, FinchAPI::Models::Introspection::ConnectionType] - required :connection_type, enum: -> { FinchAPI::Models::Introspection::ConnectionType } + # @return [Symbol, FinchAPI::Introspection::ConnectionType] + required :connection_type, enum: -> { FinchAPI::Introspection::ConnectionType } # @!attribute customer_email # The email of your customer you provided to Finch when a connect session was @@ -123,43 +123,36 @@ class Introspection < FinchAPI::Internal::Type::BaseModel required :username, String # @!method initialize(id:, account_id:, authentication_methods:, client_id:, client_type:, company_id:, connection_id:, connection_status:, connection_type:, customer_email:, customer_id:, customer_name:, manual:, payroll_provider_id:, products:, provider_id:, username:) - # Some parameter documentations has been truncated, see - # {FinchAPI::Models::Introspection} for more details. + # Some parameter documentations has been truncated, see {FinchAPI::Introspection} + # for more details. # # @param id [String] The Finch UUID of the token being introspected. # # @param account_id [String] [DEPRECATED] Use `connection_id` to associate tokens with a Finch connection ins - # ... # - # @param authentication_methods [Array] + # @param authentication_methods [Array] # # @param client_id [String] The client ID of the application associated with the `access_token`. # - # @param client_type [Symbol, FinchAPI::Models::Introspection::ClientType] The type of application associated with a token. + # @param client_type [Symbol, FinchAPI::Introspection::ClientType] The type of application associated with a token. # # @param company_id [String] [DEPRECATED] Use `connection_id` to associate tokens with a Finch connection ins - # ... # # @param connection_id [String] The Finch UUID of the connection associated with the `access_token`. # - # @param connection_status [FinchAPI::Models::Introspection::ConnectionStatus] + # @param connection_status [FinchAPI::Introspection::ConnectionStatus] # - # @param connection_type [Symbol, FinchAPI::Models::Introspection::ConnectionType] The type of the connection associated with the token. ... + # @param connection_type [Symbol, FinchAPI::Introspection::ConnectionType] The type of the connection associated with the token. # # @param customer_email [String, nil] The email of your customer you provided to Finch when a connect session was crea - # ... # # @param customer_id [String, nil] The ID of your customer you provided to Finch when a connect session was created - # ... # # @param customer_name [String, nil] The name of your customer you provided to Finch when a connect session was creat - # ... # # @param manual [Boolean] Whether the connection associated with the `access_token` uses the Assisted Conn - # ... # # @param payroll_provider_id [String] [DEPRECATED] Use `provider_id` to identify the provider instead of this payroll - # ... # # @param products [Array] An array of the authorized products associated with the `access_token`. # @@ -170,9 +163,8 @@ class Introspection < FinchAPI::Internal::Type::BaseModel class AuthenticationMethod < FinchAPI::Internal::Type::BaseModel # @!attribute connection_status # - # @return [FinchAPI::Models::Introspection::AuthenticationMethod::ConnectionStatus, nil] - optional :connection_status, - -> { FinchAPI::Models::Introspection::AuthenticationMethod::ConnectionStatus } + # @return [FinchAPI::Introspection::AuthenticationMethod::ConnectionStatus, nil] + optional :connection_status, -> { FinchAPI::Introspection::AuthenticationMethod::ConnectionStatus } # @!attribute products # An array of the authorized products associated with the `access_token`. @@ -183,17 +175,17 @@ class AuthenticationMethod < FinchAPI::Internal::Type::BaseModel # @!attribute type # The type of authentication method. # - # @return [Symbol, FinchAPI::Models::Introspection::AuthenticationMethod::Type, nil] - optional :type, enum: -> { FinchAPI::Models::Introspection::AuthenticationMethod::Type } + # @return [Symbol, FinchAPI::Introspection::AuthenticationMethod::Type, nil] + optional :type, enum: -> { FinchAPI::Introspection::AuthenticationMethod::Type } # @!method initialize(connection_status: nil, products: nil, type: nil) - # @param connection_status [FinchAPI::Models::Introspection::AuthenticationMethod::ConnectionStatus] + # @param connection_status [FinchAPI::Introspection::AuthenticationMethod::ConnectionStatus] # # @param products [Array] An array of the authorized products associated with the `access_token`. # - # @param type [Symbol, FinchAPI::Models::Introspection::AuthenticationMethod::Type] The type of authentication method. + # @param type [Symbol, FinchAPI::Introspection::AuthenticationMethod::Type] The type of authentication method. - # @see FinchAPI::Models::Introspection::AuthenticationMethod#connection_status + # @see FinchAPI::Introspection::AuthenticationMethod#connection_status class ConnectionStatus < FinchAPI::Internal::Type::BaseModel # @!attribute message # @@ -202,17 +194,17 @@ class ConnectionStatus < FinchAPI::Internal::Type::BaseModel # @!attribute status # - # @return [Symbol, FinchAPI::Models::ConnectionStatusType, nil] - optional :status, enum: -> { FinchAPI::Models::ConnectionStatusType } + # @return [Symbol, FinchAPI::ConnectionStatusType, nil] + optional :status, enum: -> { FinchAPI::ConnectionStatusType } # @!method initialize(message: nil, status: nil) # @param message [String] - # @param status [Symbol, FinchAPI::Models::ConnectionStatusType] + # @param status [Symbol, FinchAPI::ConnectionStatusType] end # The type of authentication method. # - # @see FinchAPI::Models::Introspection::AuthenticationMethod#type + # @see FinchAPI::Introspection::AuthenticationMethod#type module Type extend FinchAPI::Internal::Type::Enum @@ -229,7 +221,7 @@ module Type # The type of application associated with a token. # - # @see FinchAPI::Models::Introspection#client_type + # @see FinchAPI::Introspection#client_type module ClientType extend FinchAPI::Internal::Type::Enum @@ -241,7 +233,7 @@ module ClientType # @return [Array] end - # @see FinchAPI::Models::Introspection#connection_status + # @see FinchAPI::Introspection#connection_status class ConnectionStatus < FinchAPI::Internal::Type::BaseModel # @!attribute last_successful_sync # The datetime when the connection was last successfully synced. @@ -256,15 +248,15 @@ class ConnectionStatus < FinchAPI::Internal::Type::BaseModel # @!attribute status # - # @return [Symbol, FinchAPI::Models::ConnectionStatusType, nil] - optional :status, enum: -> { FinchAPI::Models::ConnectionStatusType } + # @return [Symbol, FinchAPI::ConnectionStatusType, nil] + optional :status, enum: -> { FinchAPI::ConnectionStatusType } # @!method initialize(last_successful_sync: nil, message: nil, status: nil) # @param last_successful_sync [Time] The datetime when the connection was last successfully synced. # # @param message [String] # - # @param status [Symbol, FinchAPI::Models::ConnectionStatusType] + # @param status [Symbol, FinchAPI::ConnectionStatusType] end # The type of the connection associated with the token. @@ -272,7 +264,7 @@ class ConnectionStatus < FinchAPI::Internal::Type::BaseModel # - `provider` - connection to an external provider # - `finch` - finch-generated data. # - # @see FinchAPI::Models::Introspection#connection_type + # @see FinchAPI::Introspection#connection_type module ConnectionType extend FinchAPI::Internal::Type::Enum diff --git a/lib/finch_api/models/job_completion_event.rb b/lib/finch_api/models/job_completion_event.rb index 6ead185c..39ce0291 100644 --- a/lib/finch_api/models/job_completion_event.rb +++ b/lib/finch_api/models/job_completion_event.rb @@ -5,17 +5,17 @@ module Models class JobCompletionEvent < FinchAPI::Models::BaseWebhookEvent # @!attribute data # - # @return [FinchAPI::Models::JobCompletionEvent::Data, nil] - optional :data, -> { FinchAPI::Models::JobCompletionEvent::Data } + # @return [FinchAPI::JobCompletionEvent::Data, nil] + optional :data, -> { FinchAPI::JobCompletionEvent::Data } # @!attribute event_type # - # @return [Symbol, FinchAPI::Models::JobCompletionEvent::EventType, nil] - optional :event_type, enum: -> { FinchAPI::Models::JobCompletionEvent::EventType } + # @return [Symbol, FinchAPI::JobCompletionEvent::EventType, nil] + optional :event_type, enum: -> { FinchAPI::JobCompletionEvent::EventType } # @!method initialize(data: nil, event_type: nil) - # @param data [FinchAPI::Models::JobCompletionEvent::Data] - # @param event_type [Symbol, FinchAPI::Models::JobCompletionEvent::EventType] + # @param data [FinchAPI::JobCompletionEvent::Data] + # @param event_type [Symbol, FinchAPI::JobCompletionEvent::EventType] class Data < FinchAPI::Internal::Type::BaseModel # @!attribute job_id diff --git a/lib/finch_api/models/jobs/automated_async_job.rb b/lib/finch_api/models/jobs/automated_async_job.rb index d10b7bfb..39bd779a 100644 --- a/lib/finch_api/models/jobs/automated_async_job.rb +++ b/lib/finch_api/models/jobs/automated_async_job.rb @@ -34,8 +34,8 @@ class AutomatedAsyncJob < FinchAPI::Internal::Type::BaseModel # @!attribute params # The input parameters for the job. # - # @return [FinchAPI::Models::Jobs::AutomatedAsyncJob::Params, nil] - required :params, -> { FinchAPI::Models::Jobs::AutomatedAsyncJob::Params }, nil?: true + # @return [FinchAPI::Jobs::AutomatedAsyncJob::Params, nil] + required :params, -> { FinchAPI::Jobs::AutomatedAsyncJob::Params }, nil?: true # @!attribute scheduled_at # The datetime a job is scheduled to be run. For scheduled jobs, this datetime can @@ -53,40 +53,38 @@ class AutomatedAsyncJob < FinchAPI::Internal::Type::BaseModel # @!attribute status # - # @return [Symbol, FinchAPI::Models::Jobs::AutomatedAsyncJob::Status] - required :status, enum: -> { FinchAPI::Models::Jobs::AutomatedAsyncJob::Status } + # @return [Symbol, FinchAPI::Jobs::AutomatedAsyncJob::Status] + required :status, enum: -> { FinchAPI::Jobs::AutomatedAsyncJob::Status } # @!attribute type # The type of automated job # - # @return [Symbol, FinchAPI::Models::Jobs::AutomatedAsyncJob::Type] - required :type, enum: -> { FinchAPI::Models::Jobs::AutomatedAsyncJob::Type } + # @return [Symbol, FinchAPI::Jobs::AutomatedAsyncJob::Type] + required :type, enum: -> { FinchAPI::Jobs::AutomatedAsyncJob::Type } # @!method initialize(completed_at:, created_at:, job_id:, job_url:, params:, scheduled_at:, started_at:, status:, type:) # Some parameter documentations has been truncated, see - # {FinchAPI::Models::Jobs::AutomatedAsyncJob} for more details. + # {FinchAPI::Jobs::AutomatedAsyncJob} for more details. # # @param completed_at [Time, nil] The datetime the job completed. # # @param created_at [Time] The datetime when the job was created. for scheduled jobs, this will be the init - # ... # # @param job_id [String] The id of the job that has been created. # # @param job_url [String] The url that can be used to retrieve the job status # - # @param params [FinchAPI::Models::Jobs::AutomatedAsyncJob::Params, nil] The input parameters for the job. + # @param params [FinchAPI::Jobs::AutomatedAsyncJob::Params, nil] The input parameters for the job. # # @param scheduled_at [Time, nil] The datetime a job is scheduled to be run. For scheduled jobs, this datetime can - # ... # # @param started_at [Time, nil] The datetime a job entered into the job queue. # - # @param status [Symbol, FinchAPI::Models::Jobs::AutomatedAsyncJob::Status] + # @param status [Symbol, FinchAPI::Jobs::AutomatedAsyncJob::Status] # - # @param type [Symbol, FinchAPI::Models::Jobs::AutomatedAsyncJob::Type] The type of automated job + # @param type [Symbol, FinchAPI::Jobs::AutomatedAsyncJob::Type] The type of automated job - # @see FinchAPI::Models::Jobs::AutomatedAsyncJob#params + # @see FinchAPI::Jobs::AutomatedAsyncJob#params class Params < FinchAPI::Internal::Type::BaseModel # @!attribute individual_id # The ID of the individual that the job was completed for. @@ -100,7 +98,7 @@ class Params < FinchAPI::Internal::Type::BaseModel # @param individual_id [String] The ID of the individual that the job was completed for. end - # @see FinchAPI::Models::Jobs::AutomatedAsyncJob#status + # @see FinchAPI::Jobs::AutomatedAsyncJob#status module Status extend FinchAPI::Internal::Type::Enum @@ -117,7 +115,7 @@ module Status # The type of automated job # - # @see FinchAPI::Models::Jobs::AutomatedAsyncJob#type + # @see FinchAPI::Jobs::AutomatedAsyncJob#type module Type extend FinchAPI::Internal::Type::Enum diff --git a/lib/finch_api/models/jobs/automated_create_params.rb b/lib/finch_api/models/jobs/automated_create_params.rb index d26c0136..568e6852 100644 --- a/lib/finch_api/models/jobs/automated_create_params.rb +++ b/lib/finch_api/models/jobs/automated_create_params.rb @@ -11,18 +11,18 @@ class AutomatedCreateParams < FinchAPI::Internal::Type::BaseModel # @!attribute type # The type of job to start. # - # @return [Symbol, FinchAPI::Models::Jobs::AutomatedCreateParams::Type] - required :type, enum: -> { FinchAPI::Models::Jobs::AutomatedCreateParams::Type } + # @return [Symbol, FinchAPI::Jobs::AutomatedCreateParams::Type] + required :type, enum: -> { FinchAPI::Jobs::AutomatedCreateParams::Type } # @!attribute params # - # @return [FinchAPI::Models::Jobs::AutomatedCreateParams::Params] - required :params, -> { FinchAPI::Models::Jobs::AutomatedCreateParams::Params } + # @return [FinchAPI::Jobs::AutomatedCreateParams::Params] + required :params, -> { FinchAPI::Jobs::AutomatedCreateParams::Params } # @!method initialize(type:, params:, request_options: {}) - # @param type [Symbol, FinchAPI::Models::Jobs::AutomatedCreateParams::Type] The type of job to start. + # @param type [Symbol, FinchAPI::Jobs::AutomatedCreateParams::Type] The type of job to start. # - # @param params [FinchAPI::Models::Jobs::AutomatedCreateParams::Params] + # @param params [FinchAPI::Jobs::AutomatedCreateParams::Params] # # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}] diff --git a/lib/finch_api/models/jobs/automated_list_response.rb b/lib/finch_api/models/jobs/automated_list_response.rb index 45618365..984291c6 100644 --- a/lib/finch_api/models/jobs/automated_list_response.rb +++ b/lib/finch_api/models/jobs/automated_list_response.rb @@ -7,8 +7,8 @@ module Jobs class AutomatedListResponse < FinchAPI::Internal::Type::BaseModel # @!attribute data # - # @return [Array] - required :data, -> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::Models::Jobs::AutomatedAsyncJob] } + # @return [Array] + required :data, -> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::Jobs::AutomatedAsyncJob] } # @!attribute meta # @@ -16,7 +16,7 @@ class AutomatedListResponse < FinchAPI::Internal::Type::BaseModel required :meta, -> { FinchAPI::Models::Jobs::AutomatedListResponse::Meta } # @!method initialize(data:, meta:) - # @param data [Array] + # @param data [Array] # @param meta [FinchAPI::Models::Jobs::AutomatedListResponse::Meta] # @see FinchAPI::Models::Jobs::AutomatedListResponse#meta @@ -35,7 +35,6 @@ class Meta < FinchAPI::Internal::Type::BaseModel # {FinchAPI::Models::Jobs::AutomatedListResponse::Meta} for more details. # # @param quotas [FinchAPI::Models::Jobs::AutomatedListResponse::Meta::Quotas] Information about remaining quotas for this connection. Only applicable for cust - # ... # @see FinchAPI::Models::Jobs::AutomatedListResponse::Meta#quotas class Quotas < FinchAPI::Internal::Type::BaseModel diff --git a/lib/finch_api/models/jobs/manual_async_job.rb b/lib/finch_api/models/jobs/manual_async_job.rb index 9ac49c07..b7bc7d1e 100644 --- a/lib/finch_api/models/jobs/manual_async_job.rb +++ b/lib/finch_api/models/jobs/manual_async_job.rb @@ -18,17 +18,17 @@ class ManualAsyncJob < FinchAPI::Internal::Type::BaseModel # @!attribute status # - # @return [Symbol, FinchAPI::Models::Jobs::ManualAsyncJob::Status] - required :status, enum: -> { FinchAPI::Models::Jobs::ManualAsyncJob::Status } + # @return [Symbol, FinchAPI::Jobs::ManualAsyncJob::Status] + required :status, enum: -> { FinchAPI::Jobs::ManualAsyncJob::Status } # @!method initialize(body:, job_id:, status:) # @param body [Array, nil] Specific information about the job, such as individual statuses for batch jobs. # # @param job_id [String] # - # @param status [Symbol, FinchAPI::Models::Jobs::ManualAsyncJob::Status] + # @param status [Symbol, FinchAPI::Jobs::ManualAsyncJob::Status] - # @see FinchAPI::Models::Jobs::ManualAsyncJob#status + # @see FinchAPI::Jobs::ManualAsyncJob#status module Status extend FinchAPI::Internal::Type::Enum diff --git a/lib/finch_api/models/operation_support_matrix.rb b/lib/finch_api/models/operation_support_matrix.rb index 67cee4ed..973c1c6e 100644 --- a/lib/finch_api/models/operation_support_matrix.rb +++ b/lib/finch_api/models/operation_support_matrix.rb @@ -12,8 +12,8 @@ class OperationSupportMatrix < FinchAPI::Internal::Type::BaseModel # - `client_access_only`: This behavior is supported by the provider, but only # available to the client and not to Finch # - # @return [Symbol, FinchAPI::Models::OperationSupport, nil] - optional :create, enum: -> { FinchAPI::Models::OperationSupport } + # @return [Symbol, FinchAPI::OperationSupport, nil] + optional :create, enum: -> { FinchAPI::OperationSupport } # @!attribute delete # - `supported`: This operation is supported by both the provider and Finch @@ -24,8 +24,8 @@ class OperationSupportMatrix < FinchAPI::Internal::Type::BaseModel # - `client_access_only`: This behavior is supported by the provider, but only # available to the client and not to Finch # - # @return [Symbol, FinchAPI::Models::OperationSupport, nil] - optional :delete, enum: -> { FinchAPI::Models::OperationSupport } + # @return [Symbol, FinchAPI::OperationSupport, nil] + optional :delete, enum: -> { FinchAPI::OperationSupport } # @!attribute read # - `supported`: This operation is supported by both the provider and Finch @@ -36,8 +36,8 @@ class OperationSupportMatrix < FinchAPI::Internal::Type::BaseModel # - `client_access_only`: This behavior is supported by the provider, but only # available to the client and not to Finch # - # @return [Symbol, FinchAPI::Models::OperationSupport, nil] - optional :read, enum: -> { FinchAPI::Models::OperationSupport } + # @return [Symbol, FinchAPI::OperationSupport, nil] + optional :read, enum: -> { FinchAPI::OperationSupport } # @!attribute update # - `supported`: This operation is supported by both the provider and Finch @@ -48,20 +48,20 @@ class OperationSupportMatrix < FinchAPI::Internal::Type::BaseModel # - `client_access_only`: This behavior is supported by the provider, but only # available to the client and not to Finch # - # @return [Symbol, FinchAPI::Models::OperationSupport, nil] - optional :update, enum: -> { FinchAPI::Models::OperationSupport } + # @return [Symbol, FinchAPI::OperationSupport, nil] + optional :update, enum: -> { FinchAPI::OperationSupport } # @!method initialize(create: nil, delete: nil, read: nil, update: nil) # Some parameter documentations has been truncated, see - # {FinchAPI::Models::OperationSupportMatrix} for more details. + # {FinchAPI::OperationSupportMatrix} for more details. # - # @param create [Symbol, FinchAPI::Models::OperationSupport] - `supported`: This operation is supported by both the provider and Finch ... + # @param create [Symbol, FinchAPI::OperationSupport] - `supported`: This operation is supported by both the provider and Finch # - # @param delete [Symbol, FinchAPI::Models::OperationSupport] - `supported`: This operation is supported by both the provider and Finch ... + # @param delete [Symbol, FinchAPI::OperationSupport] - `supported`: This operation is supported by both the provider and Finch # - # @param read [Symbol, FinchAPI::Models::OperationSupport] - `supported`: This operation is supported by both the provider and Finch ... + # @param read [Symbol, FinchAPI::OperationSupport] - `supported`: This operation is supported by both the provider and Finch # - # @param update [Symbol, FinchAPI::Models::OperationSupport] - `supported`: This operation is supported by both the provider and Finch ... + # @param update [Symbol, FinchAPI::OperationSupport] - `supported`: This operation is supported by both the provider and Finch end end end diff --git a/lib/finch_api/models/pay_statement_event.rb b/lib/finch_api/models/pay_statement_event.rb index 0ae2096a..9a9e4296 100644 --- a/lib/finch_api/models/pay_statement_event.rb +++ b/lib/finch_api/models/pay_statement_event.rb @@ -5,17 +5,17 @@ module Models class PayStatementEvent < FinchAPI::Models::BaseWebhookEvent # @!attribute data # - # @return [FinchAPI::Models::PayStatementEvent::Data, nil] - optional :data, -> { FinchAPI::Models::PayStatementEvent::Data } + # @return [FinchAPI::PayStatementEvent::Data, nil] + optional :data, -> { FinchAPI::PayStatementEvent::Data } # @!attribute event_type # - # @return [Symbol, FinchAPI::Models::PayStatementEvent::EventType, nil] - optional :event_type, enum: -> { FinchAPI::Models::PayStatementEvent::EventType } + # @return [Symbol, FinchAPI::PayStatementEvent::EventType, nil] + optional :event_type, enum: -> { FinchAPI::PayStatementEvent::EventType } # @!method initialize(data: nil, event_type: nil) - # @param data [FinchAPI::Models::PayStatementEvent::Data] - # @param event_type [Symbol, FinchAPI::Models::PayStatementEvent::EventType] + # @param data [FinchAPI::PayStatementEvent::Data] + # @param event_type [Symbol, FinchAPI::PayStatementEvent::EventType] class Data < FinchAPI::Internal::Type::BaseModel # @!attribute individual_id diff --git a/lib/finch_api/models/payment_event.rb b/lib/finch_api/models/payment_event.rb index c231659d..1f80f099 100644 --- a/lib/finch_api/models/payment_event.rb +++ b/lib/finch_api/models/payment_event.rb @@ -5,17 +5,17 @@ module Models class PaymentEvent < FinchAPI::Models::BaseWebhookEvent # @!attribute data # - # @return [FinchAPI::Models::PaymentEvent::Data, nil] - optional :data, -> { FinchAPI::Models::PaymentEvent::Data } + # @return [FinchAPI::PaymentEvent::Data, nil] + optional :data, -> { FinchAPI::PaymentEvent::Data } # @!attribute event_type # - # @return [Symbol, FinchAPI::Models::PaymentEvent::EventType, nil] - optional :event_type, enum: -> { FinchAPI::Models::PaymentEvent::EventType } + # @return [Symbol, FinchAPI::PaymentEvent::EventType, nil] + optional :event_type, enum: -> { FinchAPI::PaymentEvent::EventType } # @!method initialize(data: nil, event_type: nil) - # @param data [FinchAPI::Models::PaymentEvent::Data] - # @param event_type [Symbol, FinchAPI::Models::PaymentEvent::EventType] + # @param data [FinchAPI::PaymentEvent::Data] + # @param event_type [Symbol, FinchAPI::PaymentEvent::EventType] class Data < FinchAPI::Internal::Type::BaseModel # @!attribute pay_date diff --git a/lib/finch_api/models/provider.rb b/lib/finch_api/models/provider.rb index 45bf7446..10819aad 100644 --- a/lib/finch_api/models/provider.rb +++ b/lib/finch_api/models/provider.rb @@ -13,9 +13,9 @@ class Provider < FinchAPI::Internal::Type::BaseModel # @!attribute authentication_methods # The list of authentication methods supported by the provider. # - # @return [Array, nil] + # @return [Array, nil] optional :authentication_methods, - -> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::Models::Provider::AuthenticationMethod] } + -> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::Provider::AuthenticationMethod] } # @!attribute beta # `true` if the integration is in a beta state, `false` otherwise @@ -68,12 +68,12 @@ class Provider < FinchAPI::Internal::Type::BaseModel optional :products, FinchAPI::Internal::Type::ArrayOf[String] # @!method initialize(id: nil, authentication_methods: nil, beta: nil, display_name: nil, icon: nil, logo: nil, manual: nil, mfa_required: nil, primary_color: nil, products: nil) - # Some parameter documentations has been truncated, see - # {FinchAPI::Models::Provider} for more details. + # Some parameter documentations has been truncated, see {FinchAPI::Provider} for + # more details. # # @param id [String] The id of the payroll provider used in Connect. # - # @param authentication_methods [Array] The list of authentication methods supported by the provider. + # @param authentication_methods [Array] The list of authentication methods supported by the provider. # # @param beta [Boolean] `true` if the integration is in a beta state, `false` otherwise # @@ -84,7 +84,6 @@ class Provider < FinchAPI::Internal::Type::BaseModel # @param logo [String] The url to the official logo of the payroll provider. # # @param manual [Boolean] [DEPRECATED] Whether the Finch integration with this provider uses the Assisted - # ... # # @param mfa_required [Boolean] whether MFA is required for the provider. # @@ -97,84 +96,87 @@ class AuthenticationMethod < FinchAPI::Internal::Type::BaseModel # Each benefit type and their supported features. If the benefit type is not # supported, the property will be null # - # @return [FinchAPI::Models::HRIS::BenefitsSupport, nil] - optional :benefits_support, -> { FinchAPI::Models::HRIS::BenefitsSupport }, nil?: true + # @return [FinchAPI::HRIS::BenefitsSupport, nil] + optional :benefits_support, -> { FinchAPI::HRIS::BenefitsSupport }, nil?: true # @!attribute supported_fields # The supported data fields returned by our HR and payroll endpoints # - # @return [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields, nil] + # @return [FinchAPI::Provider::AuthenticationMethod::SupportedFields, nil] optional :supported_fields, - -> { FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields }, + -> { + FinchAPI::Provider::AuthenticationMethod::SupportedFields + }, nil?: true # @!attribute type # The type of authentication method. # - # @return [Symbol, FinchAPI::Models::Provider::AuthenticationMethod::Type, nil] - optional :type, enum: -> { FinchAPI::Models::Provider::AuthenticationMethod::Type } + # @return [Symbol, FinchAPI::Provider::AuthenticationMethod::Type, nil] + optional :type, enum: -> { FinchAPI::Provider::AuthenticationMethod::Type } # @!method initialize(benefits_support: nil, supported_fields: nil, type: nil) # Some parameter documentations has been truncated, see - # {FinchAPI::Models::Provider::AuthenticationMethod} for more details. + # {FinchAPI::Provider::AuthenticationMethod} for more details. # - # @param benefits_support [FinchAPI::Models::HRIS::BenefitsSupport, nil] Each benefit type and their supported features. If the benefit type is not suppo - # ... + # @param benefits_support [FinchAPI::HRIS::BenefitsSupport, nil] Each benefit type and their supported features. If the benefit type is not suppo # - # @param supported_fields [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields, nil] The supported data fields returned by our HR and payroll endpoints + # @param supported_fields [FinchAPI::Provider::AuthenticationMethod::SupportedFields, nil] The supported data fields returned by our HR and payroll endpoints # - # @param type [Symbol, FinchAPI::Models::Provider::AuthenticationMethod::Type] The type of authentication method. + # @param type [Symbol, FinchAPI::Provider::AuthenticationMethod::Type] The type of authentication method. - # @see FinchAPI::Models::Provider::AuthenticationMethod#supported_fields + # @see FinchAPI::Provider::AuthenticationMethod#supported_fields class SupportedFields < FinchAPI::Internal::Type::BaseModel # @!attribute company # - # @return [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company, nil] - optional :company, -> { FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company } + # @return [FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company, nil] + optional :company, -> { FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company } # @!attribute directory # - # @return [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Directory, nil] - optional :directory, -> { FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Directory } + # @return [FinchAPI::Provider::AuthenticationMethod::SupportedFields::Directory, nil] + optional :directory, -> { FinchAPI::Provider::AuthenticationMethod::SupportedFields::Directory } # @!attribute employment # - # @return [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment, nil] - optional :employment, -> { FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment } + # @return [FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment, nil] + optional :employment, -> { FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment } # @!attribute individual # - # @return [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Individual, nil] - optional :individual, -> { FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Individual } + # @return [FinchAPI::Provider::AuthenticationMethod::SupportedFields::Individual, nil] + optional :individual, -> { FinchAPI::Provider::AuthenticationMethod::SupportedFields::Individual } # @!attribute pay_group # - # @return [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayGroup, nil] - optional :pay_group, -> { FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayGroup } + # @return [FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayGroup, nil] + optional :pay_group, -> { FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayGroup } # @!attribute pay_statement # - # @return [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement, nil] + # @return [FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement, nil] optional :pay_statement, - -> { FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement } + -> { + FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement + } # @!attribute payment # - # @return [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Payment, nil] - optional :payment, -> { FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Payment } + # @return [FinchAPI::Provider::AuthenticationMethod::SupportedFields::Payment, nil] + optional :payment, -> { FinchAPI::Provider::AuthenticationMethod::SupportedFields::Payment } # @!method initialize(company: nil, directory: nil, employment: nil, individual: nil, pay_group: nil, pay_statement: nil, payment: nil) # The supported data fields returned by our HR and payroll endpoints # - # @param company [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company] - # @param directory [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Directory] - # @param employment [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment] - # @param individual [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Individual] - # @param pay_group [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayGroup] - # @param pay_statement [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement] - # @param payment [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Payment] - - # @see FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields#company + # @param company [FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company] + # @param directory [FinchAPI::Provider::AuthenticationMethod::SupportedFields::Directory] + # @param employment [FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment] + # @param individual [FinchAPI::Provider::AuthenticationMethod::SupportedFields::Individual] + # @param pay_group [FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayGroup] + # @param pay_statement [FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement] + # @param payment [FinchAPI::Provider::AuthenticationMethod::SupportedFields::Payment] + + # @see FinchAPI::Provider::AuthenticationMethod::SupportedFields#company class Company < FinchAPI::Internal::Type::BaseModel # @!attribute id # @@ -183,15 +185,17 @@ class Company < FinchAPI::Internal::Type::BaseModel # @!attribute accounts # - # @return [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Accounts, nil] + # @return [FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company::Accounts, nil] optional :accounts, - -> { FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Accounts } + -> { + FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company::Accounts + } # @!attribute departments # - # @return [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Departments, nil] + # @return [FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company::Departments, nil] optional :departments, - -> { FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Departments } + -> { FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company::Departments } # @!attribute ein # @@ -200,9 +204,11 @@ class Company < FinchAPI::Internal::Type::BaseModel # @!attribute entity # - # @return [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Entity, nil] + # @return [FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company::Entity, nil] optional :entity, - -> { FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Entity } + -> { + FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company::Entity + } # @!attribute legal_name # @@ -211,9 +217,11 @@ class Company < FinchAPI::Internal::Type::BaseModel # @!attribute locations # - # @return [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Locations, nil] + # @return [FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company::Locations, nil] optional :locations, - -> { FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Locations } + -> { + FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company::Locations + } # @!attribute primary_email # @@ -227,16 +235,16 @@ class Company < FinchAPI::Internal::Type::BaseModel # @!method initialize(id: nil, accounts: nil, departments: nil, ein: nil, entity: nil, legal_name: nil, locations: nil, primary_email: nil, primary_phone_number: nil) # @param id [Boolean] - # @param accounts [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Accounts] - # @param departments [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Departments] + # @param accounts [FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company::Accounts] + # @param departments [FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company::Departments] # @param ein [Boolean] - # @param entity [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Entity] + # @param entity [FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company::Entity] # @param legal_name [Boolean] - # @param locations [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Locations] + # @param locations [FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company::Locations] # @param primary_email [Boolean] # @param primary_phone_number [Boolean] - # @see FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company#accounts + # @see FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company#accounts class Accounts < FinchAPI::Internal::Type::BaseModel # @!attribute account_name # @@ -271,7 +279,7 @@ class Accounts < FinchAPI::Internal::Type::BaseModel # @param routing_number [Boolean] end - # @see FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company#departments + # @see FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company#departments class Departments < FinchAPI::Internal::Type::BaseModel # @!attribute name # @@ -280,15 +288,17 @@ class Departments < FinchAPI::Internal::Type::BaseModel # @!attribute parent # - # @return [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Departments::Parent, nil] + # @return [FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company::Departments::Parent, nil] optional :parent, - -> { FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Departments::Parent } + -> { + FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company::Departments::Parent + } # @!method initialize(name: nil, parent: nil) # @param name [Boolean] - # @param parent [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Departments::Parent] + # @param parent [FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company::Departments::Parent] - # @see FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Departments#parent + # @see FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company::Departments#parent class Parent < FinchAPI::Internal::Type::BaseModel # @!attribute name # @@ -300,7 +310,7 @@ class Parent < FinchAPI::Internal::Type::BaseModel end end - # @see FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company#entity + # @see FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company#entity class Entity < FinchAPI::Internal::Type::BaseModel # @!attribute subtype # @@ -317,7 +327,7 @@ class Entity < FinchAPI::Internal::Type::BaseModel # @param type [Boolean] end - # @see FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company#locations + # @see FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company#locations class Locations < FinchAPI::Internal::Type::BaseModel # @!attribute city # @@ -359,25 +369,27 @@ class Locations < FinchAPI::Internal::Type::BaseModel end end - # @see FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields#directory + # @see FinchAPI::Provider::AuthenticationMethod::SupportedFields#directory class Directory < FinchAPI::Internal::Type::BaseModel # @!attribute individuals # - # @return [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Directory::Individuals, nil] + # @return [FinchAPI::Provider::AuthenticationMethod::SupportedFields::Directory::Individuals, nil] optional :individuals, - -> { FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Directory::Individuals } + -> { FinchAPI::Provider::AuthenticationMethod::SupportedFields::Directory::Individuals } # @!attribute paging # - # @return [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Directory::Paging, nil] + # @return [FinchAPI::Provider::AuthenticationMethod::SupportedFields::Directory::Paging, nil] optional :paging, - -> { FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Directory::Paging } + -> { + FinchAPI::Provider::AuthenticationMethod::SupportedFields::Directory::Paging + } # @!method initialize(individuals: nil, paging: nil) - # @param individuals [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Directory::Individuals] - # @param paging [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Directory::Paging] + # @param individuals [FinchAPI::Provider::AuthenticationMethod::SupportedFields::Directory::Individuals] + # @param paging [FinchAPI::Provider::AuthenticationMethod::SupportedFields::Directory::Paging] - # @see FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Directory#individuals + # @see FinchAPI::Provider::AuthenticationMethod::SupportedFields::Directory#individuals class Individuals < FinchAPI::Internal::Type::BaseModel # @!attribute id # @@ -406,9 +418,11 @@ class Individuals < FinchAPI::Internal::Type::BaseModel # @!attribute manager # - # @return [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Directory::Individuals::Manager, nil] + # @return [FinchAPI::Provider::AuthenticationMethod::SupportedFields::Directory::Individuals::Manager, nil] optional :manager, - -> { FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Directory::Individuals::Manager } + -> { + FinchAPI::Provider::AuthenticationMethod::SupportedFields::Directory::Individuals::Manager + } # @!attribute middle_name # @@ -421,10 +435,10 @@ class Individuals < FinchAPI::Internal::Type::BaseModel # @param first_name [Boolean] # @param is_active [Boolean] # @param last_name [Boolean] - # @param manager [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Directory::Individuals::Manager] + # @param manager [FinchAPI::Provider::AuthenticationMethod::SupportedFields::Directory::Individuals::Manager] # @param middle_name [Boolean] - # @see FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Directory::Individuals#manager + # @see FinchAPI::Provider::AuthenticationMethod::SupportedFields::Directory::Individuals#manager class Manager < FinchAPI::Internal::Type::BaseModel # @!attribute id # @@ -436,7 +450,7 @@ class Manager < FinchAPI::Internal::Type::BaseModel end end - # @see FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Directory#paging + # @see FinchAPI::Provider::AuthenticationMethod::SupportedFields::Directory#paging class Paging < FinchAPI::Internal::Type::BaseModel # @!attribute count # @@ -454,7 +468,7 @@ class Paging < FinchAPI::Internal::Type::BaseModel end end - # @see FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields#employment + # @see FinchAPI::Provider::AuthenticationMethod::SupportedFields#employment class Employment < FinchAPI::Internal::Type::BaseModel # @!attribute id # @@ -473,15 +487,15 @@ class Employment < FinchAPI::Internal::Type::BaseModel # @!attribute department # - # @return [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::Department, nil] + # @return [FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment::Department, nil] optional :department, - -> { FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::Department } + -> { FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment::Department } # @!attribute employment # - # @return [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::Employment, nil] + # @return [FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment::Employment, nil] optional :employment, - -> { FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::Employment } + -> { FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment::Employment } # @!attribute employment_status # @@ -500,9 +514,11 @@ class Employment < FinchAPI::Internal::Type::BaseModel # @!attribute income # - # @return [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::Income, nil] + # @return [FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment::Income, nil] optional :income, - -> { FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::Income } + -> { + FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment::Income + } # @!attribute income_history # @@ -521,15 +537,19 @@ class Employment < FinchAPI::Internal::Type::BaseModel # @!attribute location # - # @return [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::Location, nil] + # @return [FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment::Location, nil] optional :location, - -> { FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::Location } + -> { + FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment::Location + } # @!attribute manager # - # @return [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::Manager, nil] + # @return [FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment::Manager, nil] optional :manager, - -> { FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::Manager } + -> { + FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment::Manager + } # @!attribute middle_name # @@ -550,22 +570,22 @@ class Employment < FinchAPI::Internal::Type::BaseModel # @param id [Boolean] # @param class_code [Boolean] # @param custom_fields [Boolean] - # @param department [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::Department] - # @param employment [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::Employment] + # @param department [FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment::Department] + # @param employment [FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment::Employment] # @param employment_status [Boolean] # @param end_date [Boolean] # @param first_name [Boolean] - # @param income [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::Income] + # @param income [FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment::Income] # @param income_history [Boolean] # @param is_active [Boolean] # @param last_name [Boolean] - # @param location [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::Location] - # @param manager [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::Manager] + # @param location [FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment::Location] + # @param manager [FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment::Manager] # @param middle_name [Boolean] # @param start_date [Boolean] # @param title [Boolean] - # @see FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment#department + # @see FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment#department class Department < FinchAPI::Internal::Type::BaseModel # @!attribute name # @@ -576,7 +596,7 @@ class Department < FinchAPI::Internal::Type::BaseModel # @param name [Boolean] end - # @see FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment#employment + # @see FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment#employment class Employment < FinchAPI::Internal::Type::BaseModel # @!attribute subtype # @@ -593,7 +613,7 @@ class Employment < FinchAPI::Internal::Type::BaseModel # @param type [Boolean] end - # @see FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment#income + # @see FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment#income class Income < FinchAPI::Internal::Type::BaseModel # @!attribute amount # @@ -616,7 +636,7 @@ class Income < FinchAPI::Internal::Type::BaseModel # @param unit [Boolean] end - # @see FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment#location + # @see FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment#location class Location < FinchAPI::Internal::Type::BaseModel # @!attribute city # @@ -657,7 +677,7 @@ class Location < FinchAPI::Internal::Type::BaseModel # @param state [Boolean] end - # @see FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment#manager + # @see FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment#manager class Manager < FinchAPI::Internal::Type::BaseModel # @!attribute id # @@ -669,7 +689,7 @@ class Manager < FinchAPI::Internal::Type::BaseModel end end - # @see FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields#individual + # @see FinchAPI::Provider::AuthenticationMethod::SupportedFields#individual class Individual < FinchAPI::Internal::Type::BaseModel # @!attribute id # @@ -683,9 +703,11 @@ class Individual < FinchAPI::Internal::Type::BaseModel # @!attribute emails # - # @return [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Individual::Emails, nil] + # @return [FinchAPI::Provider::AuthenticationMethod::SupportedFields::Individual::Emails, nil] optional :emails, - -> { FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Individual::Emails } + -> { + FinchAPI::Provider::AuthenticationMethod::SupportedFields::Individual::Emails + } # @!attribute encrypted_ssn # @@ -719,9 +741,11 @@ class Individual < FinchAPI::Internal::Type::BaseModel # @!attribute phone_numbers # - # @return [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Individual::PhoneNumbers, nil] + # @return [FinchAPI::Provider::AuthenticationMethod::SupportedFields::Individual::PhoneNumbers, nil] optional :phone_numbers, - -> { FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Individual::PhoneNumbers } + -> { + FinchAPI::Provider::AuthenticationMethod::SupportedFields::Individual::PhoneNumbers + } # @!attribute preferred_name # @@ -730,9 +754,9 @@ class Individual < FinchAPI::Internal::Type::BaseModel # @!attribute residence # - # @return [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Individual::Residence, nil] + # @return [FinchAPI::Provider::AuthenticationMethod::SupportedFields::Individual::Residence, nil] optional :residence, - -> { FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Individual::Residence } + -> { FinchAPI::Provider::AuthenticationMethod::SupportedFields::Individual::Residence } # @!attribute ssn # @@ -742,19 +766,19 @@ class Individual < FinchAPI::Internal::Type::BaseModel # @!method initialize(id: nil, dob: nil, emails: nil, encrypted_ssn: nil, ethnicity: nil, first_name: nil, gender: nil, last_name: nil, middle_name: nil, phone_numbers: nil, preferred_name: nil, residence: nil, ssn: nil) # @param id [Boolean] # @param dob [Boolean] - # @param emails [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Individual::Emails] + # @param emails [FinchAPI::Provider::AuthenticationMethod::SupportedFields::Individual::Emails] # @param encrypted_ssn [Boolean] # @param ethnicity [Boolean] # @param first_name [Boolean] # @param gender [Boolean] # @param last_name [Boolean] # @param middle_name [Boolean] - # @param phone_numbers [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Individual::PhoneNumbers] + # @param phone_numbers [FinchAPI::Provider::AuthenticationMethod::SupportedFields::Individual::PhoneNumbers] # @param preferred_name [Boolean] - # @param residence [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Individual::Residence] + # @param residence [FinchAPI::Provider::AuthenticationMethod::SupportedFields::Individual::Residence] # @param ssn [Boolean] - # @see FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Individual#emails + # @see FinchAPI::Provider::AuthenticationMethod::SupportedFields::Individual#emails class Emails < FinchAPI::Internal::Type::BaseModel # @!attribute data # @@ -771,7 +795,7 @@ class Emails < FinchAPI::Internal::Type::BaseModel # @param type [Boolean] end - # @see FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Individual#phone_numbers + # @see FinchAPI::Provider::AuthenticationMethod::SupportedFields::Individual#phone_numbers class PhoneNumbers < FinchAPI::Internal::Type::BaseModel # @!attribute data # @@ -788,7 +812,7 @@ class PhoneNumbers < FinchAPI::Internal::Type::BaseModel # @param type [Boolean] end - # @see FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Individual#residence + # @see FinchAPI::Provider::AuthenticationMethod::SupportedFields::Individual#residence class Residence < FinchAPI::Internal::Type::BaseModel # @!attribute city # @@ -830,7 +854,7 @@ class Residence < FinchAPI::Internal::Type::BaseModel end end - # @see FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields#pay_group + # @see FinchAPI::Provider::AuthenticationMethod::SupportedFields#pay_group class PayGroup < FinchAPI::Internal::Type::BaseModel # @!attribute id # @@ -859,25 +883,29 @@ class PayGroup < FinchAPI::Internal::Type::BaseModel # @param pay_frequencies [Boolean] end - # @see FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields#pay_statement + # @see FinchAPI::Provider::AuthenticationMethod::SupportedFields#pay_statement class PayStatement < FinchAPI::Internal::Type::BaseModel # @!attribute paging # - # @return [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::Paging, nil] + # @return [FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::Paging, nil] optional :paging, - -> { FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::Paging } + -> { + FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::Paging + } # @!attribute pay_statements # - # @return [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements, nil] + # @return [FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements, nil] optional :pay_statements, - -> { FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements } + -> { + FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements + } # @!method initialize(paging: nil, pay_statements: nil) - # @param paging [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::Paging] - # @param pay_statements [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements] + # @param paging [FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::Paging] + # @param pay_statements [FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements] - # @see FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement#paging + # @see FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement#paging class Paging < FinchAPI::Internal::Type::BaseModel # @!attribute count # @@ -894,25 +922,31 @@ class Paging < FinchAPI::Internal::Type::BaseModel # @param offset [Boolean] end - # @see FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement#pay_statements + # @see FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement#pay_statements class PayStatements < FinchAPI::Internal::Type::BaseModel # @!attribute earnings # - # @return [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Earnings, nil] + # @return [FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Earnings, nil] optional :earnings, - -> { FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Earnings } + -> { + FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Earnings + } # @!attribute employee_deductions # - # @return [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployeeDeductions, nil] + # @return [FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployeeDeductions, nil] optional :employee_deductions, - -> { FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployeeDeductions } + -> { + FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployeeDeductions + } # @!attribute employer_contributions # - # @return [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployerContributions, nil] + # @return [FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployerContributions, nil] optional :employer_contributions, - -> { FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployerContributions } + -> { + FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployerContributions + } # @!attribute gross_pay # @@ -936,9 +970,11 @@ class PayStatements < FinchAPI::Internal::Type::BaseModel # @!attribute taxes # - # @return [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Taxes, nil] + # @return [FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Taxes, nil] optional :taxes, - -> { FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Taxes } + -> { + FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Taxes + } # @!attribute total_hours # @@ -951,18 +987,18 @@ class PayStatements < FinchAPI::Internal::Type::BaseModel optional :type, FinchAPI::Internal::Type::Boolean # @!method initialize(earnings: nil, employee_deductions: nil, employer_contributions: nil, gross_pay: nil, individual_id: nil, net_pay: nil, payment_method: nil, taxes: nil, total_hours: nil, type: nil) - # @param earnings [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Earnings] - # @param employee_deductions [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployeeDeductions] - # @param employer_contributions [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployerContributions] + # @param earnings [FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Earnings] + # @param employee_deductions [FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployeeDeductions] + # @param employer_contributions [FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployerContributions] # @param gross_pay [Boolean] # @param individual_id [Boolean] # @param net_pay [Boolean] # @param payment_method [Boolean] - # @param taxes [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Taxes] + # @param taxes [FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Taxes] # @param total_hours [Boolean] # @param type [Boolean] - # @see FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements#earnings + # @see FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements#earnings class Earnings < FinchAPI::Internal::Type::BaseModel # @!attribute amount # @@ -991,7 +1027,7 @@ class Earnings < FinchAPI::Internal::Type::BaseModel # @param type [Boolean] end - # @see FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements#employee_deductions + # @see FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements#employee_deductions class EmployeeDeductions < FinchAPI::Internal::Type::BaseModel # @!attribute amount # @@ -1026,7 +1062,7 @@ class EmployeeDeductions < FinchAPI::Internal::Type::BaseModel # @param type [Boolean] end - # @see FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements#employer_contributions + # @see FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements#employer_contributions class EmployerContributions < FinchAPI::Internal::Type::BaseModel # @!attribute amount # @@ -1049,7 +1085,7 @@ class EmployerContributions < FinchAPI::Internal::Type::BaseModel # @param name [Boolean] end - # @see FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements#taxes + # @see FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements#taxes class Taxes < FinchAPI::Internal::Type::BaseModel # @!attribute amount # @@ -1086,7 +1122,7 @@ class Taxes < FinchAPI::Internal::Type::BaseModel end end - # @see FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields#payment + # @see FinchAPI::Provider::AuthenticationMethod::SupportedFields#payment class Payment < FinchAPI::Internal::Type::BaseModel # @!attribute id # @@ -1145,9 +1181,11 @@ class Payment < FinchAPI::Internal::Type::BaseModel # @!attribute pay_period # - # @return [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Payment::PayPeriod, nil] + # @return [FinchAPI::Provider::AuthenticationMethod::SupportedFields::Payment::PayPeriod, nil] optional :pay_period, - -> { FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Payment::PayPeriod } + -> { + FinchAPI::Provider::AuthenticationMethod::SupportedFields::Payment::PayPeriod + } # @!method initialize(id: nil, company_debit: nil, debit_date: nil, employee_taxes: nil, employer_taxes: nil, gross_pay: nil, individual_ids: nil, net_pay: nil, pay_date: nil, pay_frequencies: nil, pay_group_ids: nil, pay_period: nil) # @param id [Boolean] @@ -1161,9 +1199,9 @@ class Payment < FinchAPI::Internal::Type::BaseModel # @param pay_date [Boolean] # @param pay_frequencies [Boolean] # @param pay_group_ids [Boolean] - # @param pay_period [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Payment::PayPeriod] + # @param pay_period [FinchAPI::Provider::AuthenticationMethod::SupportedFields::Payment::PayPeriod] - # @see FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Payment#pay_period + # @see FinchAPI::Provider::AuthenticationMethod::SupportedFields::Payment#pay_period class PayPeriod < FinchAPI::Internal::Type::BaseModel # @!attribute end_date # @@ -1184,7 +1222,7 @@ class PayPeriod < FinchAPI::Internal::Type::BaseModel # The type of authentication method. # - # @see FinchAPI::Models::Provider::AuthenticationMethod#type + # @see FinchAPI::Provider::AuthenticationMethod#type module Type extend FinchAPI::Internal::Type::Enum diff --git a/lib/finch_api/models/request_forwarding_forward_params.rb b/lib/finch_api/models/request_forwarding_forward_params.rb index d6f7ac99..0a88971e 100644 --- a/lib/finch_api/models/request_forwarding_forward_params.rb +++ b/lib/finch_api/models/request_forwarding_forward_params.rb @@ -49,19 +49,14 @@ class RequestForwardingForwardParams < FinchAPI::Internal::Type::BaseModel # {FinchAPI::Models::RequestForwardingForwardParams} for more details. # # @param method_ [String] The HTTP method for the forwarded request. Valid values include: `GET` , `POST` - # ... # # @param route [String] The URL route path for the forwarded request. This value must begin with a forwa - # ... # # @param data [String, nil] The body for the forwarded request. This value must be specified as either a str - # ... # # @param headers [Object, nil] The HTTP headers to include on the forwarded request. This value must be specifi - # ... # # @param params [Object, nil] The query parameters for the forwarded request. This value must be specified as - # ... # # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}] end diff --git a/lib/finch_api/models/request_forwarding_forward_response.rb b/lib/finch_api/models/request_forwarding_forward_response.rb index f71fb2c0..28e349ac 100644 --- a/lib/finch_api/models/request_forwarding_forward_response.rb +++ b/lib/finch_api/models/request_forwarding_forward_response.rb @@ -38,16 +38,12 @@ class RequestForwardingForwardResponse < FinchAPI::Internal::Type::BaseModel # {FinchAPI::Models::RequestForwardingForwardResponse} for more details. # # @param data [String, nil] A string representation of the HTTP response body of the forwarded request’s res - # ... # # @param headers [Object, nil] The HTTP headers of the forwarded request’s response, exactly as received from t - # ... # # @param request [FinchAPI::Models::RequestForwardingForwardResponse::Request] An object containing details of your original forwarded request, for your ease o - # ... # # @param status_code [Integer] The HTTP status code of the forwarded request’s response, exactly received from - # ... # @see FinchAPI::Models::RequestForwardingForwardResponse#request class Request < FinchAPI::Internal::Type::BaseModel @@ -94,16 +90,12 @@ class Request < FinchAPI::Internal::Type::BaseModel # of reference. # # @param data [String, nil] The body that was specified for the forwarded request. If a value was not specif - # ... # # @param headers [Object, nil] The specified HTTP headers that were included in the forwarded request. If no he - # ... # # @param method_ [String] The HTTP method that was specified for the forwarded request. Valid values inclu - # ... # # @param params [Object, nil] The query parameters that were included in the forwarded request. If no query pa - # ... # # @param route [String] The URL route path that was specified for the forwarded request. end diff --git a/lib/finch_api/models/sandbox/company_update_params.rb b/lib/finch_api/models/sandbox/company_update_params.rb index 927e7027..6bd77474 100644 --- a/lib/finch_api/models/sandbox/company_update_params.rb +++ b/lib/finch_api/models/sandbox/company_update_params.rb @@ -11,17 +11,20 @@ class CompanyUpdateParams < FinchAPI::Internal::Type::BaseModel # @!attribute accounts # An array of bank account objects associated with the payroll/HRIS system. # - # @return [Array, nil] + # @return [Array, nil] required :accounts, - -> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::Models::Sandbox::CompanyUpdateParams::Account] }, + -> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::Sandbox::CompanyUpdateParams::Account] }, nil?: true # @!attribute departments # The array of company departments. # - # @return [Array, nil] + # @return [Array, nil] required :departments, - -> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::Models::Sandbox::CompanyUpdateParams::Department, nil?: true] }, + -> { + FinchAPI::Internal::Type::ArrayOf[FinchAPI::Sandbox::CompanyUpdateParams::Department, + nil?: true] + }, nil?: true # @!attribute ein @@ -33,8 +36,8 @@ class CompanyUpdateParams < FinchAPI::Internal::Type::BaseModel # @!attribute entity # The entity type object. # - # @return [FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity, nil] - required :entity, -> { FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity }, nil?: true + # @return [FinchAPI::Sandbox::CompanyUpdateParams::Entity, nil] + required :entity, -> { FinchAPI::Sandbox::CompanyUpdateParams::Entity }, nil?: true # @!attribute legal_name # The legal name of the company. @@ -44,9 +47,11 @@ class CompanyUpdateParams < FinchAPI::Internal::Type::BaseModel # @!attribute locations # - # @return [Array, nil] + # @return [Array, nil] required :locations, - -> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::Models::Location, nil?: true] }, + -> { + FinchAPI::Internal::Type::ArrayOf[FinchAPI::Location, nil?: true] + }, nil?: true # @!attribute primary_email @@ -66,22 +71,21 @@ class CompanyUpdateParams < FinchAPI::Internal::Type::BaseModel # Some parameter documentations has been truncated, see # {FinchAPI::Models::Sandbox::CompanyUpdateParams} for more details. # - # @param accounts [Array, nil] An array of bank account objects associated with the payroll/HRIS system. + # @param accounts [Array, nil] An array of bank account objects associated with the payroll/HRIS system. # - # @param departments [Array, nil] The array of company departments. + # @param departments [Array, nil] The array of company departments. # # @param ein [String, nil] The employer identification number. # - # @param entity [FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity, nil] The entity type object. + # @param entity [FinchAPI::Sandbox::CompanyUpdateParams::Entity, nil] The entity type object. # # @param legal_name [String, nil] The legal name of the company. # - # @param locations [Array, nil] + # @param locations [Array, nil] # # @param primary_email [String, nil] The email of the main administrator on the account. # # @param primary_phone_number [String, nil] The phone number of the main administrator on the account. Format: E.164, with e - # ... # # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}] @@ -101,9 +105,9 @@ class Account < FinchAPI::Internal::Type::BaseModel # @!attribute account_type # The type of bank account. # - # @return [Symbol, FinchAPI::Models::Sandbox::CompanyUpdateParams::Account::AccountType, nil] + # @return [Symbol, FinchAPI::Sandbox::CompanyUpdateParams::Account::AccountType, nil] optional :account_type, - enum: -> { FinchAPI::Models::Sandbox::CompanyUpdateParams::Account::AccountType }, + enum: -> { FinchAPI::Sandbox::CompanyUpdateParams::Account::AccountType }, nil?: true # @!attribute institution_name @@ -121,22 +125,21 @@ class Account < FinchAPI::Internal::Type::BaseModel # @!method initialize(account_name: nil, account_number: nil, account_type: nil, institution_name: nil, routing_number: nil) # Some parameter documentations has been truncated, see - # {FinchAPI::Models::Sandbox::CompanyUpdateParams::Account} for more details. + # {FinchAPI::Sandbox::CompanyUpdateParams::Account} for more details. # # @param account_name [String, nil] The name of the bank associated in the payroll/HRIS system. # # @param account_number [String, nil] 10-12 digit number to specify the bank account # - # @param account_type [Symbol, FinchAPI::Models::Sandbox::CompanyUpdateParams::Account::AccountType, nil] The type of bank account. + # @param account_type [Symbol, FinchAPI::Sandbox::CompanyUpdateParams::Account::AccountType, nil] The type of bank account. # # @param institution_name [String, nil] Name of the banking institution. # # @param routing_number [String, nil] A nine-digit code that's based on the U.S. Bank location where your account was - # ... # The type of bank account. # - # @see FinchAPI::Models::Sandbox::CompanyUpdateParams::Account#account_type + # @see FinchAPI::Sandbox::CompanyUpdateParams::Account#account_type module AccountType extend FinchAPI::Internal::Type::Enum @@ -158,15 +161,15 @@ class Department < FinchAPI::Internal::Type::BaseModel # @!attribute parent # The parent department, if present. # - # @return [FinchAPI::Models::Sandbox::CompanyUpdateParams::Department::Parent, nil] - optional :parent, -> { FinchAPI::Models::Sandbox::CompanyUpdateParams::Department::Parent }, nil?: true + # @return [FinchAPI::Sandbox::CompanyUpdateParams::Department::Parent, nil] + optional :parent, -> { FinchAPI::Sandbox::CompanyUpdateParams::Department::Parent }, nil?: true # @!method initialize(name: nil, parent: nil) # @param name [String, nil] The department name. # - # @param parent [FinchAPI::Models::Sandbox::CompanyUpdateParams::Department::Parent, nil] The parent department, if present. + # @param parent [FinchAPI::Sandbox::CompanyUpdateParams::Department::Parent, nil] The parent department, if present. - # @see FinchAPI::Models::Sandbox::CompanyUpdateParams::Department#parent + # @see FinchAPI::Sandbox::CompanyUpdateParams::Department#parent class Parent < FinchAPI::Internal::Type::BaseModel # @!attribute name # The parent department's name. @@ -185,27 +188,25 @@ class Entity < FinchAPI::Internal::Type::BaseModel # @!attribute subtype # The tax payer subtype of the company. # - # @return [Symbol, FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity::Subtype, nil] - optional :subtype, - enum: -> { FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity::Subtype }, - nil?: true + # @return [Symbol, FinchAPI::Sandbox::CompanyUpdateParams::Entity::Subtype, nil] + optional :subtype, enum: -> { FinchAPI::Sandbox::CompanyUpdateParams::Entity::Subtype }, nil?: true # @!attribute type # The tax payer type of the company. # - # @return [Symbol, FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity::Type, nil] - optional :type, enum: -> { FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity::Type }, nil?: true + # @return [Symbol, FinchAPI::Sandbox::CompanyUpdateParams::Entity::Type, nil] + optional :type, enum: -> { FinchAPI::Sandbox::CompanyUpdateParams::Entity::Type }, nil?: true # @!method initialize(subtype: nil, type: nil) # The entity type object. # - # @param subtype [Symbol, FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity::Subtype, nil] The tax payer subtype of the company. + # @param subtype [Symbol, FinchAPI::Sandbox::CompanyUpdateParams::Entity::Subtype, nil] The tax payer subtype of the company. # - # @param type [Symbol, FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity::Type, nil] The tax payer type of the company. + # @param type [Symbol, FinchAPI::Sandbox::CompanyUpdateParams::Entity::Type, nil] The tax payer type of the company. # The tax payer subtype of the company. # - # @see FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity#subtype + # @see FinchAPI::Sandbox::CompanyUpdateParams::Entity#subtype module Subtype extend FinchAPI::Internal::Type::Enum @@ -219,7 +220,7 @@ module Subtype # The tax payer type of the company. # - # @see FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity#type + # @see FinchAPI::Sandbox::CompanyUpdateParams::Entity#type module Type extend FinchAPI::Internal::Type::Enum diff --git a/lib/finch_api/models/sandbox/company_update_response.rb b/lib/finch_api/models/sandbox/company_update_response.rb index 51e0a483..f0a30c44 100644 --- a/lib/finch_api/models/sandbox/company_update_response.rb +++ b/lib/finch_api/models/sandbox/company_update_response.rb @@ -41,9 +41,11 @@ class CompanyUpdateResponse < FinchAPI::Internal::Type::BaseModel # @!attribute locations # - # @return [Array, nil] + # @return [Array, nil] required :locations, - -> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::Models::Location, nil?: true] }, + -> { + FinchAPI::Internal::Type::ArrayOf[FinchAPI::Location, nil?: true] + }, nil?: true # @!attribute primary_email @@ -73,12 +75,11 @@ class CompanyUpdateResponse < FinchAPI::Internal::Type::BaseModel # # @param legal_name [String, nil] The legal name of the company. # - # @param locations [Array, nil] + # @param locations [Array, nil] # # @param primary_email [String, nil] The email of the main administrator on the account. # # @param primary_phone_number [String, nil] The phone number of the main administrator on the account. Format: E.164, with e - # ... class Account < FinchAPI::Internal::Type::BaseModel # @!attribute account_name @@ -127,7 +128,6 @@ class Account < FinchAPI::Internal::Type::BaseModel # @param institution_name [String, nil] Name of the banking institution. # # @param routing_number [String, nil] A nine-digit code that's based on the U.S. Bank location where your account was - # ... # The type of bank account. # diff --git a/lib/finch_api/models/sandbox/connection_create_params.rb b/lib/finch_api/models/sandbox/connection_create_params.rb index 9e8d475b..9c431290 100644 --- a/lib/finch_api/models/sandbox/connection_create_params.rb +++ b/lib/finch_api/models/sandbox/connection_create_params.rb @@ -16,9 +16,11 @@ class ConnectionCreateParams < FinchAPI::Internal::Type::BaseModel # @!attribute authentication_type # - # @return [Symbol, FinchAPI::Models::Sandbox::ConnectionCreateParams::AuthenticationType, nil] + # @return [Symbol, FinchAPI::Sandbox::ConnectionCreateParams::AuthenticationType, nil] optional :authentication_type, - enum: -> { FinchAPI::Models::Sandbox::ConnectionCreateParams::AuthenticationType } + enum: -> { + FinchAPI::Sandbox::ConnectionCreateParams::AuthenticationType + } # @!attribute employee_size # Optional: the size of the employer to be created with this connection. Defaults @@ -39,10 +41,9 @@ class ConnectionCreateParams < FinchAPI::Internal::Type::BaseModel # # @param provider_id [String] The provider associated with the connection # - # @param authentication_type [Symbol, FinchAPI::Models::Sandbox::ConnectionCreateParams::AuthenticationType] + # @param authentication_type [Symbol, FinchAPI::Sandbox::ConnectionCreateParams::AuthenticationType] # # @param employee_size [Integer] Optional: the size of the employer to be created with this connection. Defaults - # ... # # @param products [Array] # 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 be276a3c..bda504fe 100644 --- a/lib/finch_api/models/sandbox/connections/account_create_params.rb +++ b/lib/finch_api/models/sandbox/connections/account_create_params.rb @@ -22,9 +22,9 @@ class AccountCreateParams < FinchAPI::Internal::Type::BaseModel # @!attribute authentication_type # - # @return [Symbol, FinchAPI::Models::Sandbox::Connections::AccountCreateParams::AuthenticationType, nil] + # @return [Symbol, FinchAPI::Sandbox::Connections::AccountCreateParams::AuthenticationType, nil] optional :authentication_type, - enum: -> { FinchAPI::Models::Sandbox::Connections::AccountCreateParams::AuthenticationType } + enum: -> { FinchAPI::Sandbox::Connections::AccountCreateParams::AuthenticationType } # @!attribute products # Optional, defaults to Organization products (`company`, `directory`, @@ -41,10 +41,9 @@ class AccountCreateParams < FinchAPI::Internal::Type::BaseModel # # @param provider_id [String] The provider associated with the `access_token` # - # @param authentication_type [Symbol, FinchAPI::Models::Sandbox::Connections::AccountCreateParams::AuthenticationType] + # @param authentication_type [Symbol, FinchAPI::Sandbox::Connections::AccountCreateParams::AuthenticationType] # # @param products [Array] Optional, defaults to Organization products (`company`, `directory`, `employment - # ... # # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}] diff --git a/lib/finch_api/models/sandbox/connections/account_update_params.rb b/lib/finch_api/models/sandbox/connections/account_update_params.rb index 2bae7b74..273e6924 100644 --- a/lib/finch_api/models/sandbox/connections/account_update_params.rb +++ b/lib/finch_api/models/sandbox/connections/account_update_params.rb @@ -11,11 +11,11 @@ class AccountUpdateParams < FinchAPI::Internal::Type::BaseModel # @!attribute connection_status # - # @return [Symbol, FinchAPI::Models::ConnectionStatusType, nil] - optional :connection_status, enum: -> { FinchAPI::Models::ConnectionStatusType } + # @return [Symbol, FinchAPI::ConnectionStatusType, nil] + optional :connection_status, enum: -> { FinchAPI::ConnectionStatusType } # @!method initialize(connection_status: nil, request_options: {}) - # @param connection_status [Symbol, FinchAPI::Models::ConnectionStatusType] + # @param connection_status [Symbol, FinchAPI::ConnectionStatusType] # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}] 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 e0fd9429..7bddc314 100644 --- a/lib/finch_api/models/sandbox/directory_create_params.rb +++ b/lib/finch_api/models/sandbox/directory_create_params.rb @@ -12,16 +12,17 @@ class DirectoryCreateParams < FinchAPI::Internal::Type::BaseModel # Array of individuals to create. Takes all combined fields from `/individual` and # `/employment` endpoints. All fields are optional. # - # @return [Array, nil] + # @return [Array, nil] optional :body, - -> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::Models::Sandbox::DirectoryCreateParams::Body] } + -> { + FinchAPI::Internal::Type::ArrayOf[FinchAPI::Sandbox::DirectoryCreateParams::Body] + } # @!method initialize(body: nil, request_options: {}) # Some parameter documentations has been truncated, see # {FinchAPI::Models::Sandbox::DirectoryCreateParams} for more details. # - # @param body [Array] Array of individuals to create. Takes all combined fields from `/individual` and - # ... + # @param body [Array] Array of individuals to create. Takes all combined fields from `/individual` and # # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}] @@ -37,17 +38,17 @@ class Body < FinchAPI::Internal::Type::BaseModel # employer in the system. Custom fields are not currently supported for assisted # connections. # - # @return [Array, nil] + # @return [Array, nil] optional :custom_fields, - -> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::CustomField] } + -> { + FinchAPI::Internal::Type::ArrayOf[FinchAPI::Sandbox::DirectoryCreateParams::Body::CustomField] + } # @!attribute department # The department object. # - # @return [FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Department, nil] - optional :department, - -> { FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Department }, - nil?: true + # @return [FinchAPI::Sandbox::DirectoryCreateParams::Body::Department, nil] + optional :department, -> { FinchAPI::Sandbox::DirectoryCreateParams::Body::Department }, nil?: true # @!attribute dob # @@ -56,25 +57,25 @@ class Body < FinchAPI::Internal::Type::BaseModel # @!attribute emails # - # @return [Array, nil] + # @return [Array, nil] optional :emails, - -> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Email] }, + -> { + FinchAPI::Internal::Type::ArrayOf[FinchAPI::Sandbox::DirectoryCreateParams::Body::Email] + }, nil?: true # @!attribute employment # The employment object. # - # @return [FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment, nil] - optional :employment, - -> { FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment }, - nil?: true + # @return [FinchAPI::Sandbox::DirectoryCreateParams::Body::Employment, nil] + optional :employment, -> { FinchAPI::Sandbox::DirectoryCreateParams::Body::Employment }, nil?: true # @!attribute employment_status # The detailed employment status of the individual. # - # @return [Symbol, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::EmploymentStatus, nil] + # @return [Symbol, FinchAPI::Sandbox::DirectoryCreateParams::Body::EmploymentStatus, nil] optional :employment_status, - enum: -> { FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::EmploymentStatus }, + enum: -> { FinchAPI::Sandbox::DirectoryCreateParams::Body::EmploymentStatus }, nil?: true # @!attribute encrypted_ssn @@ -93,9 +94,11 @@ class Body < FinchAPI::Internal::Type::BaseModel # @!attribute ethnicity # The EEOC-defined ethnicity of the individual. # - # @return [Symbol, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Ethnicity, nil] + # @return [Symbol, FinchAPI::Sandbox::DirectoryCreateParams::Body::Ethnicity, nil] optional :ethnicity, - enum: -> { FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Ethnicity }, + enum: -> { + FinchAPI::Sandbox::DirectoryCreateParams::Body::Ethnicity + }, nil?: true # @!attribute first_name @@ -107,23 +110,23 @@ class Body < FinchAPI::Internal::Type::BaseModel # @!attribute gender # The gender of the individual. # - # @return [Symbol, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Gender, nil] - optional :gender, enum: -> { FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Gender }, nil?: true + # @return [Symbol, FinchAPI::Sandbox::DirectoryCreateParams::Body::Gender, nil] + optional :gender, enum: -> { FinchAPI::Sandbox::DirectoryCreateParams::Body::Gender }, nil?: true # @!attribute income # 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. # - # @return [FinchAPI::Models::Income, nil] - optional :income, -> { FinchAPI::Models::Income }, nil?: true + # @return [FinchAPI::Income, nil] + optional :income, -> { FinchAPI::Income }, nil?: true # @!attribute income_history # The array of income history. # - # @return [Array, nil] + # @return [Array, nil] optional :income_history, - -> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::Models::Income, nil?: true] }, + -> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::Income, nil?: true] }, nil?: true # @!attribute is_active @@ -145,14 +148,14 @@ class Body < FinchAPI::Internal::Type::BaseModel # @!attribute location # - # @return [FinchAPI::Models::Location, nil] - optional :location, -> { FinchAPI::Models::Location }, nil?: true + # @return [FinchAPI::Location, nil] + optional :location, -> { FinchAPI::Location }, nil?: true # @!attribute manager # The manager object representing the manager of the individual within the org. # - # @return [FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Manager, nil] - optional :manager, -> { FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Manager }, nil?: true + # @return [FinchAPI::Sandbox::DirectoryCreateParams::Body::Manager, nil] + optional :manager, -> { FinchAPI::Sandbox::DirectoryCreateParams::Body::Manager }, nil?: true # @!attribute middle_name # The legal middle name of the individual. @@ -162,9 +165,12 @@ class Body < FinchAPI::Internal::Type::BaseModel # @!attribute phone_numbers # - # @return [Array, nil] + # @return [Array, nil] optional :phone_numbers, - -> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::PhoneNumber, nil?: true] }, + -> { + FinchAPI::Internal::Type::ArrayOf[FinchAPI::Sandbox::DirectoryCreateParams::Body::PhoneNumber, + nil?: true] + }, nil?: true # @!attribute preferred_name @@ -175,8 +181,8 @@ class Body < FinchAPI::Internal::Type::BaseModel # @!attribute residence # - # @return [FinchAPI::Models::Location, nil] - optional :residence, -> { FinchAPI::Models::Location }, nil?: true + # @return [FinchAPI::Location, nil] + optional :residence, -> { FinchAPI::Location }, nil?: true # @!attribute source_id # The source system's unique employment identifier for this individual @@ -206,38 +212,35 @@ class Body < FinchAPI::Internal::Type::BaseModel # @!method initialize(class_code: nil, custom_fields: nil, department: nil, dob: nil, emails: nil, employment: nil, employment_status: nil, encrypted_ssn: nil, end_date: nil, ethnicity: nil, first_name: nil, gender: nil, income: nil, income_history: nil, is_active: nil, last_name: nil, latest_rehire_date: nil, location: nil, manager: nil, middle_name: nil, phone_numbers: nil, preferred_name: nil, residence: nil, source_id: nil, ssn: nil, start_date: nil, title: nil) # Some parameter documentations has been truncated, see - # {FinchAPI::Models::Sandbox::DirectoryCreateParams::Body} for more details. + # {FinchAPI::Sandbox::DirectoryCreateParams::Body} for more details. # # @param class_code [String, nil] Worker's compensation classification code for this employee # - # @param custom_fields [Array] Custom fields for the individual. These are fields which are defined by the empl - # ... + # @param custom_fields [Array] Custom fields for the individual. These are fields which are defined by the empl # - # @param department [FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Department, nil] The department object. + # @param department [FinchAPI::Sandbox::DirectoryCreateParams::Body::Department, nil] The department object. # # @param dob [String, nil] # - # @param emails [Array, nil] + # @param emails [Array, nil] # - # @param employment [FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment, nil] The employment object. + # @param employment [FinchAPI::Sandbox::DirectoryCreateParams::Body::Employment, nil] The employment object. # - # @param employment_status [Symbol, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::EmploymentStatus, nil] The detailed employment status of the individual. + # @param employment_status [Symbol, FinchAPI::Sandbox::DirectoryCreateParams::Body::EmploymentStatus, nil] The detailed employment status of the individual. # # @param encrypted_ssn [String, nil] Social Security Number of the individual in **encrypted** format. This field is - # ... # # @param end_date [String, nil] # - # @param ethnicity [Symbol, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Ethnicity, nil] The EEOC-defined ethnicity of the individual. + # @param ethnicity [Symbol, FinchAPI::Sandbox::DirectoryCreateParams::Body::Ethnicity, nil] The EEOC-defined ethnicity of the individual. # # @param first_name [String, nil] The legal first name of the individual. # - # @param gender [Symbol, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Gender, nil] The gender of the individual. + # @param gender [Symbol, FinchAPI::Sandbox::DirectoryCreateParams::Body::Gender, nil] The gender of the individual. # - # @param income [FinchAPI::Models::Income, nil] The employee's income as reported by the provider. This may not always be annual - # ... + # @param income [FinchAPI::Income, nil] The employee's income as reported by the provider. This may not always be annual # - # @param income_history [Array, nil] The array of income history. + # @param income_history [Array, nil] The array of income history. # # @param is_active [Boolean, nil] `true` if the individual an an active employee or contractor at the company. # @@ -245,22 +248,21 @@ class Body < FinchAPI::Internal::Type::BaseModel # # @param latest_rehire_date [String, nil] # - # @param location [FinchAPI::Models::Location, nil] + # @param location [FinchAPI::Location, nil] # - # @param manager [FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Manager, nil] The manager object representing the manager of the individual within the org. + # @param manager [FinchAPI::Sandbox::DirectoryCreateParams::Body::Manager, nil] The manager object representing the manager of the individual within the org. # # @param middle_name [String, nil] The legal middle name of the individual. # - # @param phone_numbers [Array, nil] + # @param phone_numbers [Array, nil] # # @param preferred_name [String, nil] The preferred name of the individual. # - # @param residence [FinchAPI::Models::Location, nil] + # @param residence [FinchAPI::Location, nil] # # @param source_id [String] The source system's unique employment identifier for this individual # # @param ssn [String, nil] Social Security Number of the individual. This field is only available with the - # ... # # @param start_date [String, nil] # @@ -282,7 +284,7 @@ class CustomField < FinchAPI::Internal::Type::BaseModel # @param value [Object] end - # @see FinchAPI::Models::Sandbox::DirectoryCreateParams::Body#department + # @see FinchAPI::Sandbox::DirectoryCreateParams::Body#department class Department < FinchAPI::Internal::Type::BaseModel # @!attribute name # The name of the department associated with the individual. @@ -304,16 +306,18 @@ class Email < FinchAPI::Internal::Type::BaseModel # @!attribute type # - # @return [Symbol, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Email::Type, nil] + # @return [Symbol, FinchAPI::Sandbox::DirectoryCreateParams::Body::Email::Type, nil] optional :type, - enum: -> { FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Email::Type }, + enum: -> { + FinchAPI::Sandbox::DirectoryCreateParams::Body::Email::Type + }, nil?: true # @!method initialize(data: nil, type: nil) # @param data [String] - # @param type [Symbol, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Email::Type, nil] + # @param type [Symbol, FinchAPI::Sandbox::DirectoryCreateParams::Body::Email::Type, nil] - # @see FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Email#type + # @see FinchAPI::Sandbox::DirectoryCreateParams::Body::Email#type module Type extend FinchAPI::Internal::Type::Enum @@ -325,41 +329,41 @@ module Type end end - # @see FinchAPI::Models::Sandbox::DirectoryCreateParams::Body#employment + # @see FinchAPI::Sandbox::DirectoryCreateParams::Body#employment class Employment < FinchAPI::Internal::Type::BaseModel # @!attribute subtype # The secondary employment type of the individual. Options: `full_time`, # `part_time`, `intern`, `temp`, `seasonal` and `individual_contractor`. # - # @return [Symbol, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment::Subtype, nil] + # @return [Symbol, FinchAPI::Sandbox::DirectoryCreateParams::Body::Employment::Subtype, nil] optional :subtype, - enum: -> { FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment::Subtype }, + enum: -> { FinchAPI::Sandbox::DirectoryCreateParams::Body::Employment::Subtype }, nil?: true # @!attribute type # The main employment type of the individual. # - # @return [Symbol, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment::Type, nil] + # @return [Symbol, FinchAPI::Sandbox::DirectoryCreateParams::Body::Employment::Type, nil] optional :type, - enum: -> { FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment::Type }, + enum: -> { + FinchAPI::Sandbox::DirectoryCreateParams::Body::Employment::Type + }, nil?: true # @!method initialize(subtype: nil, type: nil) # Some parameter documentations has been truncated, see - # {FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment} for more - # details. + # {FinchAPI::Sandbox::DirectoryCreateParams::Body::Employment} for more details. # # The employment object. # - # @param subtype [Symbol, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment::Subtype, nil] The secondary employment type of the individual. Options: `full_time`, `part_ti - # ... + # @param subtype [Symbol, FinchAPI::Sandbox::DirectoryCreateParams::Body::Employment::Subtype, nil] The secondary employment type of the individual. Options: `full_time`, `part_ti # - # @param type [Symbol, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment::Type, nil] The main employment type of the individual. + # @param type [Symbol, FinchAPI::Sandbox::DirectoryCreateParams::Body::Employment::Type, nil] The main employment type of the individual. # The secondary employment type of the individual. Options: `full_time`, # `part_time`, `intern`, `temp`, `seasonal` and `individual_contractor`. # - # @see FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment#subtype + # @see FinchAPI::Sandbox::DirectoryCreateParams::Body::Employment#subtype module Subtype extend FinchAPI::Internal::Type::Enum @@ -376,7 +380,7 @@ module Subtype # The main employment type of the individual. # - # @see FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment#type + # @see FinchAPI::Sandbox::DirectoryCreateParams::Body::Employment#type module Type extend FinchAPI::Internal::Type::Enum @@ -390,7 +394,7 @@ module Type # The detailed employment status of the individual. # - # @see FinchAPI::Models::Sandbox::DirectoryCreateParams::Body#employment_status + # @see FinchAPI::Sandbox::DirectoryCreateParams::Body#employment_status module EmploymentStatus extend FinchAPI::Internal::Type::Enum @@ -408,7 +412,7 @@ module EmploymentStatus # The EEOC-defined ethnicity of the individual. # - # @see FinchAPI::Models::Sandbox::DirectoryCreateParams::Body#ethnicity + # @see FinchAPI::Sandbox::DirectoryCreateParams::Body#ethnicity module Ethnicity extend FinchAPI::Internal::Type::Enum @@ -427,7 +431,7 @@ module Ethnicity # The gender of the individual. # - # @see FinchAPI::Models::Sandbox::DirectoryCreateParams::Body#gender + # @see FinchAPI::Sandbox::DirectoryCreateParams::Body#gender module Gender extend FinchAPI::Internal::Type::Enum @@ -440,7 +444,7 @@ module Gender # @return [Array] end - # @see FinchAPI::Models::Sandbox::DirectoryCreateParams::Body#manager + # @see FinchAPI::Sandbox::DirectoryCreateParams::Body#manager class Manager < FinchAPI::Internal::Type::BaseModel # @!attribute id # A stable Finch `id` (UUID v4) for an individual in the company. @@ -462,16 +466,18 @@ class PhoneNumber < FinchAPI::Internal::Type::BaseModel # @!attribute type # - # @return [Symbol, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::PhoneNumber::Type, nil] + # @return [Symbol, FinchAPI::Sandbox::DirectoryCreateParams::Body::PhoneNumber::Type, nil] optional :type, - enum: -> { FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::PhoneNumber::Type }, + enum: -> { + FinchAPI::Sandbox::DirectoryCreateParams::Body::PhoneNumber::Type + }, nil?: true # @!method initialize(data: nil, type: nil) # @param data [String, nil] - # @param type [Symbol, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::PhoneNumber::Type, nil] + # @param type [Symbol, FinchAPI::Sandbox::DirectoryCreateParams::Body::PhoneNumber::Type, nil] - # @see FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::PhoneNumber#type + # @see FinchAPI::Sandbox::DirectoryCreateParams::Body::PhoneNumber#type module Type extend FinchAPI::Internal::Type::Enum diff --git a/lib/finch_api/models/sandbox/employment_update_params.rb b/lib/finch_api/models/sandbox/employment_update_params.rb index e8322374..c3449db2 100644 --- a/lib/finch_api/models/sandbox/employment_update_params.rb +++ b/lib/finch_api/models/sandbox/employment_update_params.rb @@ -19,28 +19,30 @@ class EmploymentUpdateParams < FinchAPI::Internal::Type::BaseModel # employer in the system. Custom fields are not currently supported for assisted # connections. # - # @return [Array, nil] + # @return [Array, nil] optional :custom_fields, - -> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::Models::Sandbox::EmploymentUpdateParams::CustomField] } + -> { + FinchAPI::Internal::Type::ArrayOf[FinchAPI::Sandbox::EmploymentUpdateParams::CustomField] + } # @!attribute department # The department object. # - # @return [FinchAPI::Models::Sandbox::EmploymentUpdateParams::Department, nil] - optional :department, -> { FinchAPI::Models::Sandbox::EmploymentUpdateParams::Department }, nil?: true + # @return [FinchAPI::Sandbox::EmploymentUpdateParams::Department, nil] + optional :department, -> { FinchAPI::Sandbox::EmploymentUpdateParams::Department }, nil?: true # @!attribute employment # The employment object. # - # @return [FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment, nil] - optional :employment, -> { FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment }, nil?: true + # @return [FinchAPI::Sandbox::EmploymentUpdateParams::Employment, nil] + optional :employment, -> { FinchAPI::Sandbox::EmploymentUpdateParams::Employment }, nil?: true # @!attribute employment_status # The detailed employment status of the individual. # - # @return [Symbol, FinchAPI::Models::Sandbox::EmploymentUpdateParams::EmploymentStatus, nil] + # @return [Symbol, FinchAPI::Sandbox::EmploymentUpdateParams::EmploymentStatus, nil] optional :employment_status, - enum: -> { FinchAPI::Models::Sandbox::EmploymentUpdateParams::EmploymentStatus }, + enum: -> { FinchAPI::Sandbox::EmploymentUpdateParams::EmploymentStatus }, nil?: true # @!attribute end_date @@ -59,15 +61,15 @@ class EmploymentUpdateParams < FinchAPI::Internal::Type::BaseModel # annualized income, but may be in units of bi-weekly, semi-monthly, daily, etc, # depending on what information the provider returns. # - # @return [FinchAPI::Models::Income, nil] - optional :income, -> { FinchAPI::Models::Income }, nil?: true + # @return [FinchAPI::Income, nil] + optional :income, -> { FinchAPI::Income }, nil?: true # @!attribute income_history # The array of income history. # - # @return [Array, nil] + # @return [Array, nil] optional :income_history, - -> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::Models::Income, nil?: true] }, + -> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::Income, nil?: true] }, nil?: true # @!attribute is_active @@ -89,14 +91,14 @@ class EmploymentUpdateParams < FinchAPI::Internal::Type::BaseModel # @!attribute location # - # @return [FinchAPI::Models::Location, nil] - optional :location, -> { FinchAPI::Models::Location }, nil?: true + # @return [FinchAPI::Location, nil] + optional :location, -> { FinchAPI::Location }, nil?: true # @!attribute manager # The manager object representing the manager of the individual within the org. # - # @return [FinchAPI::Models::Sandbox::EmploymentUpdateParams::Manager, nil] - optional :manager, -> { FinchAPI::Models::Sandbox::EmploymentUpdateParams::Manager }, nil?: true + # @return [FinchAPI::Sandbox::EmploymentUpdateParams::Manager, nil] + optional :manager, -> { FinchAPI::Sandbox::EmploymentUpdateParams::Manager }, nil?: true # @!attribute middle_name # The legal middle name of the individual. @@ -127,23 +129,21 @@ class EmploymentUpdateParams < FinchAPI::Internal::Type::BaseModel # # @param class_code [String, nil] Worker's compensation classification code for this employee # - # @param custom_fields [Array] Custom fields for the individual. These are fields which are defined by the empl - # ... + # @param custom_fields [Array] Custom fields for the individual. These are fields which are defined by the empl # - # @param department [FinchAPI::Models::Sandbox::EmploymentUpdateParams::Department, nil] The department object. + # @param department [FinchAPI::Sandbox::EmploymentUpdateParams::Department, nil] The department object. # - # @param employment [FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment, nil] The employment object. + # @param employment [FinchAPI::Sandbox::EmploymentUpdateParams::Employment, nil] The employment object. # - # @param employment_status [Symbol, FinchAPI::Models::Sandbox::EmploymentUpdateParams::EmploymentStatus, nil] The detailed employment status of the individual. + # @param employment_status [Symbol, FinchAPI::Sandbox::EmploymentUpdateParams::EmploymentStatus, nil] The detailed employment status of the individual. # # @param end_date [String, nil] # # @param first_name [String, nil] The legal first name of the individual. # - # @param income [FinchAPI::Models::Income, nil] The employee's income as reported by the provider. This may not always be annual - # ... + # @param income [FinchAPI::Income, nil] The employee's income as reported by the provider. This may not always be annual # - # @param income_history [Array, nil] The array of income history. + # @param income_history [Array, nil] The array of income history. # # @param is_active [Boolean, nil] `true` if the individual an an active employee or contractor at the company. # @@ -151,9 +151,9 @@ class EmploymentUpdateParams < FinchAPI::Internal::Type::BaseModel # # @param latest_rehire_date [String, nil] # - # @param location [FinchAPI::Models::Location, nil] + # @param location [FinchAPI::Location, nil] # - # @param manager [FinchAPI::Models::Sandbox::EmploymentUpdateParams::Manager, nil] The manager object representing the manager of the individual within the org. + # @param manager [FinchAPI::Sandbox::EmploymentUpdateParams::Manager, nil] The manager object representing the manager of the individual within the org. # # @param middle_name [String, nil] The legal middle name of the individual. # @@ -199,35 +199,33 @@ class Employment < FinchAPI::Internal::Type::BaseModel # The secondary employment type of the individual. Options: `full_time`, # `part_time`, `intern`, `temp`, `seasonal` and `individual_contractor`. # - # @return [Symbol, FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment::Subtype, nil] + # @return [Symbol, FinchAPI::Sandbox::EmploymentUpdateParams::Employment::Subtype, nil] optional :subtype, - enum: -> { FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment::Subtype }, + enum: -> { + FinchAPI::Sandbox::EmploymentUpdateParams::Employment::Subtype + }, nil?: true # @!attribute type # The main employment type of the individual. # - # @return [Symbol, FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment::Type, nil] - optional :type, - enum: -> { FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment::Type }, - nil?: true + # @return [Symbol, FinchAPI::Sandbox::EmploymentUpdateParams::Employment::Type, nil] + optional :type, enum: -> { FinchAPI::Sandbox::EmploymentUpdateParams::Employment::Type }, nil?: true # @!method initialize(subtype: nil, type: nil) # Some parameter documentations has been truncated, see - # {FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment} for more - # details. + # {FinchAPI::Sandbox::EmploymentUpdateParams::Employment} for more details. # # The employment object. # - # @param subtype [Symbol, FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment::Subtype, nil] The secondary employment type of the individual. Options: `full_time`, `part_ti - # ... + # @param subtype [Symbol, FinchAPI::Sandbox::EmploymentUpdateParams::Employment::Subtype, nil] The secondary employment type of the individual. Options: `full_time`, `part_ti # - # @param type [Symbol, FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment::Type, nil] The main employment type of the individual. + # @param type [Symbol, FinchAPI::Sandbox::EmploymentUpdateParams::Employment::Type, nil] The main employment type of the individual. # The secondary employment type of the individual. Options: `full_time`, # `part_time`, `intern`, `temp`, `seasonal` and `individual_contractor`. # - # @see FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment#subtype + # @see FinchAPI::Sandbox::EmploymentUpdateParams::Employment#subtype module Subtype extend FinchAPI::Internal::Type::Enum @@ -244,7 +242,7 @@ module Subtype # The main employment type of the individual. # - # @see FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment#type + # @see FinchAPI::Sandbox::EmploymentUpdateParams::Employment#type module Type extend FinchAPI::Internal::Type::Enum diff --git a/lib/finch_api/models/sandbox/employment_update_response.rb b/lib/finch_api/models/sandbox/employment_update_response.rb index 82d6aa85..2a8d48ed 100644 --- a/lib/finch_api/models/sandbox/employment_update_response.rb +++ b/lib/finch_api/models/sandbox/employment_update_response.rb @@ -62,15 +62,15 @@ class EmploymentUpdateResponse < FinchAPI::Internal::Type::BaseModel # annualized income, but may be in units of bi-weekly, semi-monthly, daily, etc, # depending on what information the provider returns. # - # @return [FinchAPI::Models::Income, nil] - optional :income, -> { FinchAPI::Models::Income }, nil?: true + # @return [FinchAPI::Income, nil] + optional :income, -> { FinchAPI::Income }, nil?: true # @!attribute income_history # The array of income history. # - # @return [Array, nil] + # @return [Array, nil] optional :income_history, - -> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::Models::Income, nil?: true] }, + -> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::Income, nil?: true] }, nil?: true # @!attribute is_active @@ -92,8 +92,8 @@ class EmploymentUpdateResponse < FinchAPI::Internal::Type::BaseModel # @!attribute location # - # @return [FinchAPI::Models::Location, nil] - optional :location, -> { FinchAPI::Models::Location }, nil?: true + # @return [FinchAPI::Location, nil] + optional :location, -> { FinchAPI::Location }, nil?: true # @!attribute manager # The manager object representing the manager of the individual within the org. @@ -133,7 +133,6 @@ class EmploymentUpdateResponse < FinchAPI::Internal::Type::BaseModel # @param class_code [String, nil] Worker's compensation classification code for this employee # # @param custom_fields [Array] Custom fields for the individual. These are fields which are defined by the empl - # ... # # @param department [FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Department, nil] The department object. # @@ -145,10 +144,9 @@ class EmploymentUpdateResponse < FinchAPI::Internal::Type::BaseModel # # @param first_name [String, nil] The legal first name of the individual. # - # @param income [FinchAPI::Models::Income, nil] The employee's income as reported by the provider. This may not always be annual - # ... + # @param income [FinchAPI::Income, nil] The employee's income as reported by the provider. This may not always be annual # - # @param income_history [Array, nil] The array of income history. + # @param income_history [Array, nil] The array of income history. # # @param is_active [Boolean, nil] `true` if the individual an an active employee or contractor at the company. # @@ -156,7 +154,7 @@ class EmploymentUpdateResponse < FinchAPI::Internal::Type::BaseModel # # @param latest_rehire_date [String, nil] # - # @param location [FinchAPI::Models::Location, nil] + # @param location [FinchAPI::Location, nil] # # @param manager [FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Manager, nil] The manager object representing the manager of the individual within the org. # @@ -225,7 +223,6 @@ class Employment < FinchAPI::Internal::Type::BaseModel # The employment object. # # @param subtype [Symbol, FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Employment::Subtype, nil] The secondary employment type of the individual. Options: `full_time`, `part_ti - # ... # # @param type [Symbol, FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Employment::Type, nil] The main employment type of the individual. diff --git a/lib/finch_api/models/sandbox/individual_update_params.rb b/lib/finch_api/models/sandbox/individual_update_params.rb index 242355c6..1999744c 100644 --- a/lib/finch_api/models/sandbox/individual_update_params.rb +++ b/lib/finch_api/models/sandbox/individual_update_params.rb @@ -15,9 +15,9 @@ class IndividualUpdateParams < FinchAPI::Internal::Type::BaseModel # @!attribute emails # - # @return [Array, nil] + # @return [Array, nil] optional :emails, - -> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::Models::Sandbox::IndividualUpdateParams::Email] }, + -> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::Sandbox::IndividualUpdateParams::Email] }, nil?: true # @!attribute encrypted_ssn @@ -31,8 +31,8 @@ class IndividualUpdateParams < FinchAPI::Internal::Type::BaseModel # @!attribute ethnicity # The EEOC-defined ethnicity of the individual. # - # @return [Symbol, FinchAPI::Models::Sandbox::IndividualUpdateParams::Ethnicity, nil] - optional :ethnicity, enum: -> { FinchAPI::Models::Sandbox::IndividualUpdateParams::Ethnicity }, nil?: true + # @return [Symbol, FinchAPI::Sandbox::IndividualUpdateParams::Ethnicity, nil] + optional :ethnicity, enum: -> { FinchAPI::Sandbox::IndividualUpdateParams::Ethnicity }, nil?: true # @!attribute first_name # The legal first name of the individual. @@ -43,8 +43,8 @@ class IndividualUpdateParams < FinchAPI::Internal::Type::BaseModel # @!attribute gender # The gender of the individual. # - # @return [Symbol, FinchAPI::Models::Sandbox::IndividualUpdateParams::Gender, nil] - optional :gender, enum: -> { FinchAPI::Models::Sandbox::IndividualUpdateParams::Gender }, nil?: true + # @return [Symbol, FinchAPI::Sandbox::IndividualUpdateParams::Gender, nil] + optional :gender, enum: -> { FinchAPI::Sandbox::IndividualUpdateParams::Gender }, nil?: true # @!attribute last_name # The legal last name of the individual. @@ -60,9 +60,12 @@ class IndividualUpdateParams < FinchAPI::Internal::Type::BaseModel # @!attribute phone_numbers # - # @return [Array, nil] + # @return [Array, nil] optional :phone_numbers, - -> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::Models::Sandbox::IndividualUpdateParams::PhoneNumber, nil?: true] }, + -> { + FinchAPI::Internal::Type::ArrayOf[FinchAPI::Sandbox::IndividualUpdateParams::PhoneNumber, + nil?: true] + }, nil?: true # @!attribute preferred_name @@ -73,8 +76,8 @@ class IndividualUpdateParams < FinchAPI::Internal::Type::BaseModel # @!attribute residence # - # @return [FinchAPI::Models::Location, nil] - optional :residence, -> { FinchAPI::Models::Location }, nil?: true + # @return [FinchAPI::Location, nil] + optional :residence, -> { FinchAPI::Location }, nil?: true # @!attribute ssn # Social Security Number of the individual. This field is only available with the @@ -91,29 +94,27 @@ class IndividualUpdateParams < FinchAPI::Internal::Type::BaseModel # # @param dob [String, nil] # - # @param emails [Array, nil] + # @param emails [Array, nil] # # @param encrypted_ssn [String, nil] Social Security Number of the individual in **encrypted** format. This field is - # ... # - # @param ethnicity [Symbol, FinchAPI::Models::Sandbox::IndividualUpdateParams::Ethnicity, nil] The EEOC-defined ethnicity of the individual. + # @param ethnicity [Symbol, FinchAPI::Sandbox::IndividualUpdateParams::Ethnicity, nil] The EEOC-defined ethnicity of the individual. # # @param first_name [String, nil] The legal first name of the individual. # - # @param gender [Symbol, FinchAPI::Models::Sandbox::IndividualUpdateParams::Gender, nil] The gender of the individual. + # @param gender [Symbol, FinchAPI::Sandbox::IndividualUpdateParams::Gender, nil] The gender of the individual. # # @param last_name [String, nil] The legal last name of the individual. # # @param middle_name [String, nil] The legal middle name of the individual. # - # @param phone_numbers [Array, nil] + # @param phone_numbers [Array, nil] # # @param preferred_name [String, nil] The preferred name of the individual. # - # @param residence [FinchAPI::Models::Location, nil] + # @param residence [FinchAPI::Location, nil] # # @param ssn [String, nil] Social Security Number of the individual. This field is only available with the - # ... # # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}] @@ -125,14 +126,14 @@ class Email < FinchAPI::Internal::Type::BaseModel # @!attribute type # - # @return [Symbol, FinchAPI::Models::Sandbox::IndividualUpdateParams::Email::Type, nil] - optional :type, enum: -> { FinchAPI::Models::Sandbox::IndividualUpdateParams::Email::Type }, nil?: true + # @return [Symbol, FinchAPI::Sandbox::IndividualUpdateParams::Email::Type, nil] + optional :type, enum: -> { FinchAPI::Sandbox::IndividualUpdateParams::Email::Type }, nil?: true # @!method initialize(data: nil, type: nil) # @param data [String] - # @param type [Symbol, FinchAPI::Models::Sandbox::IndividualUpdateParams::Email::Type, nil] + # @param type [Symbol, FinchAPI::Sandbox::IndividualUpdateParams::Email::Type, nil] - # @see FinchAPI::Models::Sandbox::IndividualUpdateParams::Email#type + # @see FinchAPI::Sandbox::IndividualUpdateParams::Email#type module Type extend FinchAPI::Internal::Type::Enum @@ -182,16 +183,18 @@ class PhoneNumber < FinchAPI::Internal::Type::BaseModel # @!attribute type # - # @return [Symbol, FinchAPI::Models::Sandbox::IndividualUpdateParams::PhoneNumber::Type, nil] + # @return [Symbol, FinchAPI::Sandbox::IndividualUpdateParams::PhoneNumber::Type, nil] optional :type, - enum: -> { FinchAPI::Models::Sandbox::IndividualUpdateParams::PhoneNumber::Type }, + enum: -> { + FinchAPI::Sandbox::IndividualUpdateParams::PhoneNumber::Type + }, nil?: true # @!method initialize(data: nil, type: nil) # @param data [String, nil] - # @param type [Symbol, FinchAPI::Models::Sandbox::IndividualUpdateParams::PhoneNumber::Type, nil] + # @param type [Symbol, FinchAPI::Sandbox::IndividualUpdateParams::PhoneNumber::Type, nil] - # @see FinchAPI::Models::Sandbox::IndividualUpdateParams::PhoneNumber#type + # @see FinchAPI::Sandbox::IndividualUpdateParams::PhoneNumber#type module Type extend FinchAPI::Internal::Type::Enum diff --git a/lib/finch_api/models/sandbox/individual_update_response.rb b/lib/finch_api/models/sandbox/individual_update_response.rb index cdc36aaa..58d89e10 100644 --- a/lib/finch_api/models/sandbox/individual_update_response.rb +++ b/lib/finch_api/models/sandbox/individual_update_response.rb @@ -78,8 +78,8 @@ class IndividualUpdateResponse < FinchAPI::Internal::Type::BaseModel # @!attribute residence # - # @return [FinchAPI::Models::Location, nil] - optional :residence, -> { FinchAPI::Models::Location }, nil?: true + # @return [FinchAPI::Location, nil] + optional :residence, -> { FinchAPI::Location }, nil?: true # @!attribute ssn # Social Security Number of the individual. This field is only available with the @@ -101,7 +101,6 @@ class IndividualUpdateResponse < FinchAPI::Internal::Type::BaseModel # @param emails [Array, nil] # # @param encrypted_ssn [String, nil] Social Security Number of the individual in **encrypted** format. This field is - # ... # # @param ethnicity [Symbol, FinchAPI::Models::Sandbox::IndividualUpdateResponse::Ethnicity, nil] The EEOC-defined ethnicity of the individual. # @@ -117,10 +116,9 @@ class IndividualUpdateResponse < FinchAPI::Internal::Type::BaseModel # # @param preferred_name [String, nil] The preferred name of the individual. # - # @param residence [FinchAPI::Models::Location, nil] + # @param residence [FinchAPI::Location, nil] # # @param ssn [String, nil] Social Security Number of the individual. This field is only available with the - # ... class Email < FinchAPI::Internal::Type::BaseModel # @!attribute data diff --git a/lib/finch_api/models/sandbox/job_create_params.rb b/lib/finch_api/models/sandbox/job_create_params.rb index dd8669dc..91e9d454 100644 --- a/lib/finch_api/models/sandbox/job_create_params.rb +++ b/lib/finch_api/models/sandbox/job_create_params.rb @@ -11,11 +11,11 @@ class JobCreateParams < FinchAPI::Internal::Type::BaseModel # @!attribute type # The type of job to start. Currently the only supported type is `data_sync_all` # - # @return [Symbol, FinchAPI::Models::Sandbox::JobCreateParams::Type] - required :type, enum: -> { FinchAPI::Models::Sandbox::JobCreateParams::Type } + # @return [Symbol, FinchAPI::Sandbox::JobCreateParams::Type] + required :type, enum: -> { FinchAPI::Sandbox::JobCreateParams::Type } # @!method initialize(type:, request_options: {}) - # @param type [Symbol, FinchAPI::Models::Sandbox::JobCreateParams::Type] The type of job to start. Currently the only supported type is `data_sync_all` + # @param type [Symbol, FinchAPI::Sandbox::JobCreateParams::Type] The type of job to start. Currently the only supported type is `data_sync_all` # # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}] 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 ab09268c..5b5ba043 100644 --- a/lib/finch_api/models/sandbox/jobs/configuration_retrieve_response.rb +++ b/lib/finch_api/models/sandbox/jobs/configuration_retrieve_response.rb @@ -6,7 +6,7 @@ module Sandbox module Jobs # @type [FinchAPI::Internal::Type::Converter] ConfigurationRetrieveResponse = - FinchAPI::Internal::Type::ArrayOf[-> { FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration }] + FinchAPI::Internal::Type::ArrayOf[-> { FinchAPI::Sandbox::Jobs::SandboxJobConfiguration }] 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 5be58d24..57597215 100644 --- a/lib/finch_api/models/sandbox/jobs/sandbox_job_configuration.rb +++ b/lib/finch_api/models/sandbox/jobs/sandbox_job_configuration.rb @@ -8,20 +8,20 @@ module Jobs class SandboxJobConfiguration < FinchAPI::Internal::Type::BaseModel # @!attribute completion_status # - # @return [Symbol, FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration::CompletionStatus] + # @return [Symbol, FinchAPI::Sandbox::Jobs::SandboxJobConfiguration::CompletionStatus] required :completion_status, - enum: -> { FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration::CompletionStatus } + enum: -> { FinchAPI::Sandbox::Jobs::SandboxJobConfiguration::CompletionStatus } # @!attribute type # - # @return [Symbol, FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration::Type] - required :type, enum: -> { FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration::Type } + # @return [Symbol, FinchAPI::Sandbox::Jobs::SandboxJobConfiguration::Type] + required :type, enum: -> { FinchAPI::Sandbox::Jobs::SandboxJobConfiguration::Type } # @!method initialize(completion_status:, type:) - # @param completion_status [Symbol, FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration::CompletionStatus] - # @param type [Symbol, FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration::Type] + # @param completion_status [Symbol, FinchAPI::Sandbox::Jobs::SandboxJobConfiguration::CompletionStatus] + # @param type [Symbol, FinchAPI::Sandbox::Jobs::SandboxJobConfiguration::Type] - # @see FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration#completion_status + # @see FinchAPI::Sandbox::Jobs::SandboxJobConfiguration#completion_status module CompletionStatus extend FinchAPI::Internal::Type::Enum @@ -34,7 +34,7 @@ module CompletionStatus # @return [Array] end - # @see FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration#type + # @see FinchAPI::Sandbox::Jobs::SandboxJobConfiguration#type module Type extend FinchAPI::Internal::Type::Enum diff --git a/lib/finch_api/models/sandbox/payment_create_params.rb b/lib/finch_api/models/sandbox/payment_create_params.rb index 2ee13453..23b275a4 100644 --- a/lib/finch_api/models/sandbox/payment_create_params.rb +++ b/lib/finch_api/models/sandbox/payment_create_params.rb @@ -15,9 +15,11 @@ class PaymentCreateParams < FinchAPI::Internal::Type::BaseModel # @!attribute pay_statements # - # @return [Array, nil] + # @return [Array, nil] optional :pay_statements, - -> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement] } + -> { + FinchAPI::Internal::Type::ArrayOf[FinchAPI::Sandbox::PaymentCreateParams::PayStatement] + } # @!attribute start_date # @@ -26,7 +28,7 @@ class PaymentCreateParams < FinchAPI::Internal::Type::BaseModel # @!method initialize(end_date: nil, pay_statements: nil, start_date: nil, request_options: {}) # @param end_date [String] - # @param pay_statements [Array] + # @param pay_statements [Array] # @param start_date [String] # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}] @@ -34,30 +36,39 @@ class PayStatement < FinchAPI::Internal::Type::BaseModel # @!attribute earnings # The array of earnings objects associated with this pay statement # - # @return [Array, nil] + # @return [Array, nil] optional :earnings, - -> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning, nil?: true] }, + -> { + FinchAPI::Internal::Type::ArrayOf[FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Earning, + nil?: true] + }, nil?: true # @!attribute employee_deductions # The array of deductions objects associated with this pay statement. # - # @return [Array, nil] + # @return [Array, nil] optional :employee_deductions, - -> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction, nil?: true] }, + -> { + FinchAPI::Internal::Type::ArrayOf[FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction, + nil?: true] + }, nil?: true # @!attribute employer_contributions # - # @return [Array, nil] + # @return [Array, nil] optional :employer_contributions, - -> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution, nil?: true] }, + -> { + FinchAPI::Internal::Type::ArrayOf[FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution, + nil?: true] + }, nil?: true # @!attribute gross_pay # - # @return [FinchAPI::Models::Money, nil] - optional :gross_pay, -> { FinchAPI::Models::Money }, nil?: true + # @return [FinchAPI::Money, nil] + optional :gross_pay, -> { FinchAPI::Money }, nil?: true # @!attribute individual_id # A stable Finch `id` (UUID v4) for an individual in the company @@ -67,23 +78,26 @@ class PayStatement < FinchAPI::Internal::Type::BaseModel # @!attribute net_pay # - # @return [FinchAPI::Models::Money, nil] - optional :net_pay, -> { FinchAPI::Models::Money }, nil?: true + # @return [FinchAPI::Money, nil] + optional :net_pay, -> { FinchAPI::Money }, nil?: true # @!attribute payment_method # The payment method. # - # @return [Symbol, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::PaymentMethod, nil] + # @return [Symbol, FinchAPI::Sandbox::PaymentCreateParams::PayStatement::PaymentMethod, nil] optional :payment_method, - enum: -> { FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::PaymentMethod }, + enum: -> { FinchAPI::Sandbox::PaymentCreateParams::PayStatement::PaymentMethod }, nil?: true # @!attribute taxes # The array of taxes objects associated with this pay statement. # - # @return [Array, nil] + # @return [Array, nil] optional :taxes, - -> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax, nil?: true] }, + -> { + FinchAPI::Internal::Type::ArrayOf[FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Tax, + nil?: true] + }, nil?: true # @!attribute total_hours @@ -95,31 +109,29 @@ class PayStatement < FinchAPI::Internal::Type::BaseModel # @!attribute type # The type of the payment associated with the pay statement. # - # @return [Symbol, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Type, nil] - optional :type, - enum: -> { FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Type }, - nil?: true + # @return [Symbol, FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Type, nil] + optional :type, enum: -> { FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Type }, nil?: true # @!method initialize(earnings: nil, employee_deductions: nil, employer_contributions: nil, gross_pay: nil, individual_id: nil, net_pay: nil, payment_method: nil, taxes: nil, total_hours: nil, type: nil) - # @param earnings [Array, nil] The array of earnings objects associated with this pay statement + # @param earnings [Array, nil] The array of earnings objects associated with this pay statement # - # @param employee_deductions [Array, nil] The array of deductions objects associated with this pay statement. + # @param employee_deductions [Array, nil] The array of deductions objects associated with this pay statement. # - # @param employer_contributions [Array, nil] + # @param employer_contributions [Array, nil] # - # @param gross_pay [FinchAPI::Models::Money, nil] + # @param gross_pay [FinchAPI::Money, nil] # # @param individual_id [String] A stable Finch `id` (UUID v4) for an individual in the company # - # @param net_pay [FinchAPI::Models::Money, nil] + # @param net_pay [FinchAPI::Money, nil] # - # @param payment_method [Symbol, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::PaymentMethod, nil] The payment method. + # @param payment_method [Symbol, FinchAPI::Sandbox::PaymentCreateParams::PayStatement::PaymentMethod, nil] The payment method. # - # @param taxes [Array, nil] The array of taxes objects associated with this pay statement. + # @param taxes [Array, nil] The array of taxes objects associated with this pay statement. # # @param total_hours [Float, nil] The number of hours worked for this pay period # - # @param type [Symbol, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Type, nil] The type of the payment associated with the pay statement. + # @param type [Symbol, FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Type, nil] The type of the payment associated with the pay statement. class Earning < FinchAPI::Internal::Type::BaseModel # @!attribute amount @@ -130,9 +142,9 @@ class Earning < FinchAPI::Internal::Type::BaseModel # @!attribute attributes # - # @return [FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Attributes, nil] + # @return [FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Earning::Attributes, nil] optional :attributes, - -> { FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Attributes }, + -> { FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Earning::Attributes }, nil?: true # @!attribute currency @@ -157,63 +169,64 @@ class Earning < FinchAPI::Internal::Type::BaseModel # @!attribute type # The type of earning. # - # @return [Symbol, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Type, nil] + # @return [Symbol, FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Earning::Type, nil] optional :type, - enum: -> { FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Type }, + enum: -> { FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Earning::Type }, nil?: true # @!method initialize(amount: nil, attributes: nil, currency: nil, hours: nil, name: nil, type: nil) # Some parameter documentations has been truncated, see - # {FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning} for more + # {FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Earning} for more # details. # # @param amount [Integer, nil] The earnings amount in cents. # - # @param attributes [FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Attributes, nil] + # @param attributes [FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Earning::Attributes, nil] # # @param currency [String, nil] The earnings currency code. # # @param hours [Float, nil] The number of hours associated with this earning. (For salaried employees, this - # ... # # @param name [String, nil] The exact name of the deduction from the pay statement. # - # @param type [Symbol, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Type, nil] The type of earning. + # @param type [Symbol, FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Earning::Type, nil] The type of earning. - # @see FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning#attributes + # @see FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Earning#attributes class Attributes < FinchAPI::Internal::Type::BaseModel # @!attribute metadata # - # @return [FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Attributes::Metadata, nil] + # @return [FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Earning::Attributes::Metadata, nil] optional :metadata, - -> { FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Attributes::Metadata } + -> { + FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Earning::Attributes::Metadata + } # @!method initialize(metadata: nil) - # @param metadata [FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Attributes::Metadata] + # @param metadata [FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Earning::Attributes::Metadata] - # @see FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Attributes#metadata + # @see FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Earning::Attributes#metadata class Metadata < FinchAPI::Internal::Type::BaseModel # @!attribute metadata # 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.). # - # @return [Hash{Symbol=>Object}, nil] - optional :metadata, FinchAPI::Internal::Type::HashOf[FinchAPI::Internal::Type::Unknown] + # @return [Hash{Symbol=>Object, nil}, nil] + optional :metadata, + FinchAPI::Internal::Type::HashOf[FinchAPI::Internal::Type::Unknown, nil?: true] # @!method initialize(metadata: nil) # Some parameter documentations has been truncated, see - # {FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Attributes::Metadata} + # {FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Earning::Attributes::Metadata} # for more details. # - # @param metadata [Hash{Symbol=>Object}] The metadata to be attached to the entity by existing rules. It is a key-value p - # ... + # @param metadata [Hash{Symbol=>Object, nil}] The metadata to be attached to the entity by existing rules. It is a key-value p end end # The type of earning. # - # @see FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning#type + # @see FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Earning#type module Type extend FinchAPI::Internal::Type::Enum @@ -245,9 +258,11 @@ class EmployeeDeduction < FinchAPI::Internal::Type::BaseModel # @!attribute attributes # - # @return [FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Attributes, nil] + # @return [FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Attributes, nil] optional :attributes, - -> { FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Attributes }, + -> { + FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Attributes + }, nil?: true # @!attribute currency @@ -271,13 +286,13 @@ class EmployeeDeduction < FinchAPI::Internal::Type::BaseModel # @!attribute type # Type of benefit. # - # @return [Symbol, FinchAPI::Models::HRIS::BenefitType, nil] - optional :type, enum: -> { FinchAPI::Models::HRIS::BenefitType }, nil?: true + # @return [Symbol, FinchAPI::HRIS::BenefitType, nil] + optional :type, enum: -> { FinchAPI::HRIS::BenefitType }, nil?: true # @!method initialize(amount: nil, attributes: nil, currency: nil, name: nil, pre_tax: nil, type: nil) # @param amount [Integer, nil] The deduction amount in cents. # - # @param attributes [FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Attributes, nil] + # @param attributes [FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Attributes, nil] # # @param currency [String, nil] The deduction currency. # @@ -285,36 +300,38 @@ class EmployeeDeduction < FinchAPI::Internal::Type::BaseModel # # @param pre_tax [Boolean, nil] Boolean indicating if the deduction is pre-tax. # - # @param type [Symbol, FinchAPI::Models::HRIS::BenefitType, nil] Type of benefit. + # @param type [Symbol, FinchAPI::HRIS::BenefitType, nil] Type of benefit. - # @see FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction#attributes + # @see FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction#attributes class Attributes < FinchAPI::Internal::Type::BaseModel # @!attribute metadata # - # @return [FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Attributes::Metadata, nil] + # @return [FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Attributes::Metadata, nil] optional :metadata, - -> { FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Attributes::Metadata } + -> { + FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Attributes::Metadata + } # @!method initialize(metadata: nil) - # @param metadata [FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Attributes::Metadata] + # @param metadata [FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Attributes::Metadata] - # @see FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Attributes#metadata + # @see FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Attributes#metadata class Metadata < FinchAPI::Internal::Type::BaseModel # @!attribute metadata # 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.). # - # @return [Hash{Symbol=>Object}, nil] - optional :metadata, FinchAPI::Internal::Type::HashOf[FinchAPI::Internal::Type::Unknown] + # @return [Hash{Symbol=>Object, nil}, nil] + optional :metadata, + FinchAPI::Internal::Type::HashOf[FinchAPI::Internal::Type::Unknown, nil?: true] # @!method initialize(metadata: nil) # Some parameter documentations has been truncated, see - # {FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Attributes::Metadata} + # {FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Attributes::Metadata} # for more details. # - # @param metadata [Hash{Symbol=>Object}] The metadata to be attached to the entity by existing rules. It is a key-value p - # ... + # @param metadata [Hash{Symbol=>Object, nil}] The metadata to be attached to the entity by existing rules. It is a key-value p end end end @@ -328,9 +345,11 @@ class EmployerContribution < FinchAPI::Internal::Type::BaseModel # @!attribute attributes # - # @return [FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Attributes, nil] + # @return [FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Attributes, nil] optional :attributes, - -> { FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Attributes }, + -> { + FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Attributes + }, nil?: true # @!attribute currency @@ -348,55 +367,57 @@ class EmployerContribution < FinchAPI::Internal::Type::BaseModel # @!attribute type # Type of benefit. # - # @return [Symbol, FinchAPI::Models::HRIS::BenefitType, nil] - optional :type, enum: -> { FinchAPI::Models::HRIS::BenefitType }, nil?: true + # @return [Symbol, FinchAPI::HRIS::BenefitType, nil] + optional :type, enum: -> { FinchAPI::HRIS::BenefitType }, nil?: true # @!method initialize(amount: nil, attributes: nil, currency: nil, name: nil, type: nil) # @param amount [Integer, nil] The contribution amount in cents. # - # @param attributes [FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Attributes, nil] + # @param attributes [FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Attributes, nil] # # @param currency [String, nil] The contribution currency. # # @param name [String, nil] The contribution name from the pay statement. # - # @param type [Symbol, FinchAPI::Models::HRIS::BenefitType, nil] Type of benefit. + # @param type [Symbol, FinchAPI::HRIS::BenefitType, nil] Type of benefit. - # @see FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution#attributes + # @see FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution#attributes class Attributes < FinchAPI::Internal::Type::BaseModel # @!attribute metadata # - # @return [FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Attributes::Metadata, nil] + # @return [FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Attributes::Metadata, nil] optional :metadata, - -> { FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Attributes::Metadata } + -> { + FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Attributes::Metadata + } # @!method initialize(metadata: nil) - # @param metadata [FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Attributes::Metadata] + # @param metadata [FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Attributes::Metadata] - # @see FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Attributes#metadata + # @see FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Attributes#metadata class Metadata < FinchAPI::Internal::Type::BaseModel # @!attribute metadata # 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.). # - # @return [Hash{Symbol=>Object}, nil] - optional :metadata, FinchAPI::Internal::Type::HashOf[FinchAPI::Internal::Type::Unknown] + # @return [Hash{Symbol=>Object, nil}, nil] + optional :metadata, + FinchAPI::Internal::Type::HashOf[FinchAPI::Internal::Type::Unknown, nil?: true] # @!method initialize(metadata: nil) # Some parameter documentations has been truncated, see - # {FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Attributes::Metadata} + # {FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Attributes::Metadata} # for more details. # - # @param metadata [Hash{Symbol=>Object}] The metadata to be attached to the entity by existing rules. It is a key-value p - # ... + # @param metadata [Hash{Symbol=>Object, nil}] The metadata to be attached to the entity by existing rules. It is a key-value p end end end # The payment method. # - # @see FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement#payment_method + # @see FinchAPI::Sandbox::PaymentCreateParams::PayStatement#payment_method module PaymentMethod extend FinchAPI::Internal::Type::Enum @@ -416,9 +437,9 @@ class Tax < FinchAPI::Internal::Type::BaseModel # @!attribute attributes # - # @return [FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::Attributes, nil] + # @return [FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Tax::Attributes, nil] optional :attributes, - -> { FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::Attributes }, + -> { FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Tax::Attributes }, nil?: true # @!attribute currency @@ -442,15 +463,17 @@ class Tax < FinchAPI::Internal::Type::BaseModel # @!attribute type # The type of taxes. # - # @return [Symbol, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::Type, nil] + # @return [Symbol, FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Tax::Type, nil] optional :type, - enum: -> { FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::Type }, + enum: -> { + FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Tax::Type + }, nil?: true # @!method initialize(amount: nil, attributes: nil, currency: nil, employer: nil, name: nil, type: nil) # @param amount [Integer, nil] The tax amount in cents. # - # @param attributes [FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::Attributes, nil] + # @param attributes [FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Tax::Attributes, nil] # # @param currency [String, nil] The currency code. # @@ -458,42 +481,44 @@ class Tax < FinchAPI::Internal::Type::BaseModel # # @param name [String, nil] The exact name of tax from the pay statement. # - # @param type [Symbol, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::Type, nil] The type of taxes. + # @param type [Symbol, FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Tax::Type, nil] The type of taxes. - # @see FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax#attributes + # @see FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Tax#attributes class Attributes < FinchAPI::Internal::Type::BaseModel # @!attribute metadata # - # @return [FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::Attributes::Metadata, nil] + # @return [FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Tax::Attributes::Metadata, nil] optional :metadata, - -> { FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::Attributes::Metadata } + -> { + FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Tax::Attributes::Metadata + } # @!method initialize(metadata: nil) - # @param metadata [FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::Attributes::Metadata] + # @param metadata [FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Tax::Attributes::Metadata] - # @see FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::Attributes#metadata + # @see FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Tax::Attributes#metadata class Metadata < FinchAPI::Internal::Type::BaseModel # @!attribute metadata # 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.). # - # @return [Hash{Symbol=>Object}, nil] - optional :metadata, FinchAPI::Internal::Type::HashOf[FinchAPI::Internal::Type::Unknown] + # @return [Hash{Symbol=>Object, nil}, nil] + optional :metadata, + FinchAPI::Internal::Type::HashOf[FinchAPI::Internal::Type::Unknown, nil?: true] # @!method initialize(metadata: nil) # Some parameter documentations has been truncated, see - # {FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::Attributes::Metadata} + # {FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Tax::Attributes::Metadata} # for more details. # - # @param metadata [Hash{Symbol=>Object}] The metadata to be attached to the entity by existing rules. It is a key-value p - # ... + # @param metadata [Hash{Symbol=>Object, nil}] The metadata to be attached to the entity by existing rules. It is a key-value p end end # The type of taxes. # - # @see FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax#type + # @see FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Tax#type module Type extend FinchAPI::Internal::Type::Enum @@ -509,7 +534,7 @@ module Type # The type of the payment associated with the pay statement. # - # @see FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement#type + # @see FinchAPI::Sandbox::PaymentCreateParams::PayStatement#type module Type extend FinchAPI::Internal::Type::Enum diff --git a/lib/finch_api/models/webhook_event.rb b/lib/finch_api/models/webhook_event.rb index 5a8f9d4a..7273c7e9 100644 --- a/lib/finch_api/models/webhook_event.rb +++ b/lib/finch_api/models/webhook_event.rb @@ -7,24 +7,24 @@ module WebhookEvent discriminator :event_type - variant :"account.updated", -> { FinchAPI::Models::AccountUpdateEvent } + variant :"account.updated", -> { FinchAPI::AccountUpdateEvent } - variant :"company.updated", -> { FinchAPI::Models::CompanyEvent } + variant :"company.updated", -> { FinchAPI::CompanyEvent } - variant -> { FinchAPI::Models::JobCompletionEvent } + variant -> { FinchAPI::JobCompletionEvent } - variant -> { FinchAPI::Models::DirectoryEvent } + variant -> { FinchAPI::DirectoryEvent } - variant -> { FinchAPI::Models::EmploymentEvent } + variant -> { FinchAPI::EmploymentEvent } - variant -> { FinchAPI::Models::IndividualEvent } + variant -> { FinchAPI::IndividualEvent } - variant -> { FinchAPI::Models::PaymentEvent } + variant -> { FinchAPI::PaymentEvent } - variant -> { FinchAPI::Models::PayStatementEvent } + variant -> { FinchAPI::PayStatementEvent } # @!method self.variants - # @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)] + # @return [Array(FinchAPI::AccountUpdateEvent, FinchAPI::CompanyEvent, FinchAPI::JobCompletionEvent, FinchAPI::DirectoryEvent, FinchAPI::EmploymentEvent, FinchAPI::IndividualEvent, FinchAPI::PaymentEvent, FinchAPI::PayStatementEvent)] end end end diff --git a/lib/finch_api/resources/access_tokens.rb b/lib/finch_api/resources/access_tokens.rb index 43e77300..041d7878 100644 --- a/lib/finch_api/resources/access_tokens.rb +++ b/lib/finch_api/resources/access_tokens.rb @@ -13,16 +13,16 @@ class AccessTokens # @param redirect_uri [String] # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil] # - # @return [FinchAPI::Models::CreateAccessTokenResponse] + # @return [FinchAPI::CreateAccessTokenResponse] # # @see FinchAPI::Models::AccessTokenCreateParams def create(params) - parsed, options = FinchAPI::Models::AccessTokenCreateParams.dump_request(params) + parsed, options = FinchAPI::AccessTokenCreateParams.dump_request(params) @client.request( method: :post, path: "auth/token", body: parsed, - model: FinchAPI::Models::CreateAccessTokenResponse, + model: FinchAPI::CreateAccessTokenResponse, options: options ) end diff --git a/lib/finch_api/resources/account.rb b/lib/finch_api/resources/account.rb index 31ce59b5..22d38d4c 100644 --- a/lib/finch_api/resources/account.rb +++ b/lib/finch_api/resources/account.rb @@ -9,14 +9,14 @@ class Account # # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil] # - # @return [FinchAPI::Models::DisconnectResponse] + # @return [FinchAPI::DisconnectResponse] # # @see FinchAPI::Models::AccountDisconnectParams def disconnect(params = {}) @client.request( method: :post, path: "disconnect", - model: FinchAPI::Models::DisconnectResponse, + model: FinchAPI::DisconnectResponse, options: params[:request_options] ) end @@ -27,14 +27,14 @@ def disconnect(params = {}) # # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil] # - # @return [FinchAPI::Models::Introspection] + # @return [FinchAPI::Introspection] # # @see FinchAPI::Models::AccountIntrospectParams def introspect(params = {}) @client.request( method: :get, path: "introspect", - model: FinchAPI::Models::Introspection, + model: FinchAPI::Introspection, options: params[:request_options] ) end diff --git a/lib/finch_api/resources/connect/sessions.rb b/lib/finch_api/resources/connect/sessions.rb index 158b2e18..7f82a709 100644 --- a/lib/finch_api/resources/connect/sessions.rb +++ b/lib/finch_api/resources/connect/sessions.rb @@ -15,20 +15,19 @@ class Sessions # # @param customer_name [String] # - # @param products [Array] + # @param products [Array] # # @param customer_email [String, nil] # - # @param integration [FinchAPI::Models::Connect::SessionNewParams::Integration, nil] + # @param integration [FinchAPI::Connect::SessionNewParams::Integration, nil] # # @param manual [Boolean, nil] # # @param minutes_to_expire [Float, nil] The number of minutes until the session expires (defaults to 43,200, which is 30 - # ... # # @param redirect_uri [String, nil] # - # @param sandbox [Symbol, FinchAPI::Models::Connect::SessionNewParams::Sandbox, nil] + # @param sandbox [Symbol, FinchAPI::Connect::SessionNewParams::Sandbox, nil] # # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil] # @@ -36,7 +35,7 @@ class Sessions # # @see FinchAPI::Models::Connect::SessionNewParams def new(params) - parsed, options = FinchAPI::Models::Connect::SessionNewParams.dump_request(params) + parsed, options = FinchAPI::Connect::SessionNewParams.dump_request(params) @client.request( method: :post, path: "connect/sessions", @@ -56,9 +55,8 @@ def new(params) # @param connection_id [String] The ID of the existing connection to reauthenticate # # @param minutes_to_expire [Integer, nil] The number of minutes until the session expires (defaults to 43,200, which is 30 - # ... # - # @param products [Array, nil] The products to request access to (optional for reauthentication) + # @param products [Array, nil] The products to request access to (optional for reauthentication) # # @param redirect_uri [String, nil] The URI to redirect to after the Connect flow is completed # @@ -68,7 +66,7 @@ def new(params) # # @see FinchAPI::Models::Connect::SessionReauthenticateParams def reauthenticate(params) - parsed, options = FinchAPI::Models::Connect::SessionReauthenticateParams.dump_request(params) + parsed, options = FinchAPI::Connect::SessionReauthenticateParams.dump_request(params) @client.request( method: :post, path: "connect/sessions/reauthenticate", diff --git a/lib/finch_api/resources/hris/benefits.rb b/lib/finch_api/resources/hris/benefits.rb index 03243f9b..76bc7388 100644 --- a/lib/finch_api/resources/hris/benefits.rb +++ b/lib/finch_api/resources/hris/benefits.rb @@ -15,27 +15,26 @@ class Benefits # # @overload create(company_contribution: nil, description: nil, frequency: nil, type: nil, request_options: {}) # - # @param company_contribution [FinchAPI::Models::HRIS::BenefitCreateParams::CompanyContribution, nil] The company match for this benefit. + # @param company_contribution [FinchAPI::HRIS::BenefitCreateParams::CompanyContribution, nil] The company match for this benefit. # # @param description [String] Name of the benefit as it appears in the provider and pay statements. Recommend - # ... # - # @param frequency [Symbol, FinchAPI::Models::HRIS::BenefitFrequency, nil] The frequency of the benefit deduction/contribution. + # @param frequency [Symbol, FinchAPI::HRIS::BenefitFrequency, nil] The frequency of the benefit deduction/contribution. # - # @param type [Symbol, FinchAPI::Models::HRIS::BenefitType, nil] Type of benefit. + # @param type [Symbol, FinchAPI::HRIS::BenefitType, nil] Type of benefit. # # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil] # - # @return [FinchAPI::Models::HRIS::CreateCompanyBenefitsResponse] + # @return [FinchAPI::HRIS::CreateCompanyBenefitsResponse] # # @see FinchAPI::Models::HRIS::BenefitCreateParams def create(params = {}) - parsed, options = FinchAPI::Models::HRIS::BenefitCreateParams.dump_request(params) + parsed, options = FinchAPI::HRIS::BenefitCreateParams.dump_request(params) @client.request( method: :post, path: "employer/benefits", body: parsed, - model: FinchAPI::Models::HRIS::CreateCompanyBenefitsResponse, + model: FinchAPI::HRIS::CreateCompanyBenefitsResponse, options: options ) end @@ -47,14 +46,14 @@ def create(params = {}) # @param benefit_id [String] # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil] # - # @return [FinchAPI::Models::HRIS::CompanyBenefit] + # @return [FinchAPI::HRIS::CompanyBenefit] # # @see FinchAPI::Models::HRIS::BenefitRetrieveParams def retrieve(benefit_id, params = {}) @client.request( method: :get, path: ["employer/benefits/%1$s", benefit_id], - model: FinchAPI::Models::HRIS::CompanyBenefit, + model: FinchAPI::HRIS::CompanyBenefit, options: params[:request_options] ) end @@ -69,16 +68,16 @@ def retrieve(benefit_id, params = {}) # # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil] # - # @return [FinchAPI::Models::HRIS::UpdateCompanyBenefitResponse] + # @return [FinchAPI::HRIS::UpdateCompanyBenefitResponse] # # @see FinchAPI::Models::HRIS::BenefitUpdateParams def update(benefit_id, params = {}) - parsed, options = FinchAPI::Models::HRIS::BenefitUpdateParams.dump_request(params) + parsed, options = FinchAPI::HRIS::BenefitUpdateParams.dump_request(params) @client.request( method: :post, path: ["employer/benefits/%1$s", benefit_id], body: parsed, - model: FinchAPI::Models::HRIS::UpdateCompanyBenefitResponse, + model: FinchAPI::HRIS::UpdateCompanyBenefitResponse, options: options ) end @@ -89,7 +88,7 @@ def update(benefit_id, params = {}) # # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil] # - # @return [FinchAPI::Internal::SinglePage] + # @return [FinchAPI::Internal::SinglePage] # # @see FinchAPI::Models::HRIS::BenefitListParams def list(params = {}) @@ -97,7 +96,7 @@ def list(params = {}) method: :get, path: "employer/benefits", page: FinchAPI::Internal::SinglePage, - model: FinchAPI::Models::HRIS::CompanyBenefit, + model: FinchAPI::HRIS::CompanyBenefit, options: params[:request_options] ) end diff --git a/lib/finch_api/resources/hris/benefits/individuals.rb b/lib/finch_api/resources/hris/benefits/individuals.rb index 92e713a6..40110bce 100644 --- a/lib/finch_api/resources/hris/benefits/individuals.rb +++ b/lib/finch_api/resources/hris/benefits/individuals.rb @@ -14,20 +14,20 @@ class Individuals # # @param benefit_id [String] # - # @param individuals [Array] Array of the individual_id to enroll and a configuration object. + # @param individuals [Array] Array of the individual_id to enroll and a configuration object. # # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil] # - # @return [FinchAPI::Models::HRIS::Benefits::EnrolledIndividualBenefitResponse] + # @return [FinchAPI::HRIS::Benefits::EnrolledIndividualBenefitResponse] # # @see FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams def enroll_many(benefit_id, params = {}) - parsed, options = FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams.dump_request(params) + parsed, options = FinchAPI::HRIS::Benefits::IndividualEnrollManyParams.dump_request(params) @client.request( method: :post, path: ["employer/benefits/%1$s/individuals", benefit_id], body: parsed[:individuals], - model: FinchAPI::Models::HRIS::Benefits::EnrolledIndividualBenefitResponse, + model: FinchAPI::HRIS::Benefits::EnrolledIndividualBenefitResponse, options: options ) end @@ -62,22 +62,20 @@ def enrolled_ids(benefit_id, params = {}) # @param benefit_id [String] # # @param individual_ids [String] comma-delimited list of stable Finch uuids for each individual. If empty, defaul - # ... # # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil] # - # @return [FinchAPI::Internal::SinglePage] + # @return [FinchAPI::Internal::SinglePage] # # @see FinchAPI::Models::HRIS::Benefits::IndividualRetrieveManyBenefitsParams def retrieve_many_benefits(benefit_id, params = {}) - parsed, options = - FinchAPI::Models::HRIS::Benefits::IndividualRetrieveManyBenefitsParams.dump_request(params) + parsed, options = FinchAPI::HRIS::Benefits::IndividualRetrieveManyBenefitsParams.dump_request(params) @client.request( method: :get, path: ["employer/benefits/%1$s/individuals", benefit_id], query: parsed, page: FinchAPI::Internal::SinglePage, - model: FinchAPI::Models::HRIS::Benefits::IndividualBenefit, + model: FinchAPI::HRIS::Benefits::IndividualBenefit, options: options ) end @@ -92,16 +90,16 @@ def retrieve_many_benefits(benefit_id, params = {}) # # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil] # - # @return [FinchAPI::Models::HRIS::Benefits::UnenrolledIndividualBenefitResponse] + # @return [FinchAPI::HRIS::Benefits::UnenrolledIndividualBenefitResponse] # # @see FinchAPI::Models::HRIS::Benefits::IndividualUnenrollManyParams def unenroll_many(benefit_id, params = {}) - parsed, options = FinchAPI::Models::HRIS::Benefits::IndividualUnenrollManyParams.dump_request(params) + parsed, options = FinchAPI::HRIS::Benefits::IndividualUnenrollManyParams.dump_request(params) @client.request( method: :delete, path: ["employer/benefits/%1$s/individuals", benefit_id], body: parsed, - model: FinchAPI::Models::HRIS::Benefits::UnenrolledIndividualBenefitResponse, + model: FinchAPI::HRIS::Benefits::UnenrolledIndividualBenefitResponse, options: options ) end diff --git a/lib/finch_api/resources/hris/company.rb b/lib/finch_api/resources/hris/company.rb index e47565ac..9cb9f66b 100644 --- a/lib/finch_api/resources/hris/company.rb +++ b/lib/finch_api/resources/hris/company.rb @@ -13,14 +13,14 @@ class Company # # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil] # - # @return [FinchAPI::Models::HRIS::HRISCompany] + # @return [FinchAPI::HRIS::HRISCompany] # # @see FinchAPI::Models::HRIS::CompanyRetrieveParams def retrieve(params = {}) @client.request( method: :get, path: "employer/company", - model: FinchAPI::Models::HRIS::HRISCompany, + model: FinchAPI::HRIS::HRISCompany, options: params[:request_options] ) end diff --git a/lib/finch_api/resources/hris/company/pay_statement_item.rb b/lib/finch_api/resources/hris/company/pay_statement_item.rb index 4501ddc7..2fd9ef77 100644 --- a/lib/finch_api/resources/hris/company/pay_statement_item.rb +++ b/lib/finch_api/resources/hris/company/pay_statement_item.rb @@ -17,16 +17,13 @@ class PayStatementItem # # @overload list(categories: nil, end_date: nil, name: nil, start_date: nil, type: nil, request_options: {}) # - # @param categories [Array] Comma-delimited list of pay statement item categories to filter on. If empty, de - # ... + # @param categories [Array] Comma-delimited list of pay statement item categories to filter on. If empty, de # # @param end_date [Date] The end date to retrieve pay statement items by via their last seen pay date in - # ... # # @param name [String] Case-insensitive partial match search by pay statement item name. # # @param start_date [Date] The start date to retrieve pay statement items by via their last seen pay date ( - # ... # # @param type [String] String search by pay statement item type. # @@ -36,7 +33,7 @@ class PayStatementItem # # @see FinchAPI::Models::HRIS::Company::PayStatementItemListParams def list(params = {}) - parsed, options = FinchAPI::Models::HRIS::Company::PayStatementItemListParams.dump_request(params) + parsed, options = FinchAPI::HRIS::Company::PayStatementItemListParams.dump_request(params) @client.request( method: :get, path: "employer/pay-statement-item", diff --git a/lib/finch_api/resources/hris/company/pay_statement_item/rules.rb b/lib/finch_api/resources/hris/company/pay_statement_item/rules.rb index aac7c66b..c9e32e04 100644 --- a/lib/finch_api/resources/hris/company/pay_statement_item/rules.rb +++ b/lib/finch_api/resources/hris/company/pay_statement_item/rules.rb @@ -15,15 +15,15 @@ class Rules # # @overload create(attributes: nil, conditions: nil, effective_end_date: nil, effective_start_date: nil, entity_type: nil, request_options: {}) # - # @param attributes [FinchAPI::Models::HRIS::Company::PayStatementItem::RuleCreateParams::Attributes] Specifies the fields to be applied when the condition is met. + # @param attributes [FinchAPI::HRIS::Company::PayStatementItem::RuleCreateParams::Attributes] Specifies the fields to be applied when the condition is met. # - # @param conditions [Array] + # @param conditions [Array] # # @param effective_end_date [String, nil] Specifies when the rules should stop applying rules based on the date. # # @param effective_start_date [String, nil] Specifies when the rule should begin applying based on the date. # - # @param entity_type [Symbol, FinchAPI::Models::HRIS::Company::PayStatementItem::RuleCreateParams::EntityType] The entity type to which the rule is applied. + # @param entity_type [Symbol, FinchAPI::HRIS::Company::PayStatementItem::RuleCreateParams::EntityType] The entity type to which the rule is applied. # # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil] # @@ -31,8 +31,7 @@ class Rules # # @see FinchAPI::Models::HRIS::Company::PayStatementItem::RuleCreateParams def create(params = {}) - parsed, options = - FinchAPI::Models::HRIS::Company::PayStatementItem::RuleCreateParams.dump_request(params) + parsed, options = FinchAPI::HRIS::Company::PayStatementItem::RuleCreateParams.dump_request(params) @client.request( method: :post, path: "employer/pay-statement-item/rule", @@ -55,8 +54,7 @@ def create(params = {}) # # @see FinchAPI::Models::HRIS::Company::PayStatementItem::RuleUpdateParams def update(rule_id, params = {}) - parsed, options = - FinchAPI::Models::HRIS::Company::PayStatementItem::RuleUpdateParams.dump_request(params) + parsed, options = FinchAPI::HRIS::Company::PayStatementItem::RuleUpdateParams.dump_request(params) @client.request( method: :put, path: ["employer/pay-statement-item/rule/%1$s", rule_id], diff --git a/lib/finch_api/resources/hris/directory.rb b/lib/finch_api/resources/hris/directory.rb index 1eb9f1f6..d9be05a1 100644 --- a/lib/finch_api/resources/hris/directory.rb +++ b/lib/finch_api/resources/hris/directory.rb @@ -14,17 +14,17 @@ class Directory # # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil] # - # @return [FinchAPI::Internal::IndividualsPage] + # @return [FinchAPI::Internal::IndividualsPage] # # @see FinchAPI::Models::HRIS::DirectoryListParams def list(params = {}) - parsed, options = FinchAPI::Models::HRIS::DirectoryListParams.dump_request(params) + parsed, options = FinchAPI::HRIS::DirectoryListParams.dump_request(params) @client.request( method: :get, path: "employer/directory", query: parsed, page: FinchAPI::Internal::IndividualsPage, - model: FinchAPI::Models::HRIS::IndividualInDirectory, + model: FinchAPI::HRIS::IndividualInDirectory, options: options ) end diff --git a/lib/finch_api/resources/hris/documents.rb b/lib/finch_api/resources/hris/documents.rb index f1b75120..a4a2b2f1 100644 --- a/lib/finch_api/resources/hris/documents.rb +++ b/lib/finch_api/resources/hris/documents.rb @@ -13,14 +13,12 @@ class Documents # @overload list(individual_ids: nil, limit: nil, offset: nil, types: nil, request_options: {}) # # @param individual_ids [Array] Comma-delimited list of stable Finch uuids for each individual. If empty, defaul - # ... # # @param limit [Integer] Number of documents to return (defaults to all) # # @param offset [Integer] Index to start from (defaults to 0) # - # @param types [Array] Comma-delimited list of document types to filter on. If empty, defaults to all t - # ... + # @param types [Array] Comma-delimited list of document types to filter on. If empty, defaults to all t # # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil] # @@ -28,7 +26,7 @@ class Documents # # @see FinchAPI::Models::HRIS::DocumentListParams def list(params = {}) - parsed, options = FinchAPI::Models::HRIS::DocumentListParams.dump_request(params) + parsed, options = FinchAPI::HRIS::DocumentListParams.dump_request(params) @client.request( method: :get, path: "employer/documents", @@ -47,7 +45,7 @@ def list(params = {}) # # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil] # - # @return [FinchAPI::Models::HRIS::W42020, FinchAPI::Models::HRIS::W42005] + # @return [FinchAPI::HRIS::W42020, FinchAPI::HRIS::W42005] # # @see FinchAPI::Models::HRIS::DocumentRetreiveParams def retreive(document_id, params = {}) diff --git a/lib/finch_api/resources/hris/employments.rb b/lib/finch_api/resources/hris/employments.rb index 61253061..e4323772 100644 --- a/lib/finch_api/resources/hris/employments.rb +++ b/lib/finch_api/resources/hris/employments.rb @@ -8,21 +8,21 @@ class Employments # # @overload retrieve_many(requests:, request_options: {}) # - # @param requests [Array] The array of batch requests. + # @param requests [Array] The array of batch requests. # # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil] # - # @return [FinchAPI::Internal::ResponsesPage] + # @return [FinchAPI::Internal::ResponsesPage] # # @see FinchAPI::Models::HRIS::EmploymentRetrieveManyParams def retrieve_many(params) - parsed, options = FinchAPI::Models::HRIS::EmploymentRetrieveManyParams.dump_request(params) + parsed, options = FinchAPI::HRIS::EmploymentRetrieveManyParams.dump_request(params) @client.request( method: :post, path: "employer/employment", body: parsed, page: FinchAPI::Internal::ResponsesPage, - model: FinchAPI::Models::HRIS::EmploymentDataResponse, + model: FinchAPI::HRIS::EmploymentDataResponse, options: options ) end diff --git a/lib/finch_api/resources/hris/individuals.rb b/lib/finch_api/resources/hris/individuals.rb index cde9f43b..b8a64499 100644 --- a/lib/finch_api/resources/hris/individuals.rb +++ b/lib/finch_api/resources/hris/individuals.rb @@ -8,21 +8,21 @@ class Individuals # # @overload retrieve_many(options: nil, requests: nil, request_options: {}) # - # @param options [FinchAPI::Models::HRIS::IndividualRetrieveManyParams::Options, nil] - # @param requests [Array] + # @param options [FinchAPI::HRIS::IndividualRetrieveManyParams::Options, nil] + # @param requests [Array] # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil] # - # @return [FinchAPI::Internal::ResponsesPage] + # @return [FinchAPI::Internal::ResponsesPage] # # @see FinchAPI::Models::HRIS::IndividualRetrieveManyParams def retrieve_many(params = {}) - parsed, options = FinchAPI::Models::HRIS::IndividualRetrieveManyParams.dump_request(params) + parsed, options = FinchAPI::HRIS::IndividualRetrieveManyParams.dump_request(params) @client.request( method: :post, path: "employer/individual", body: parsed, page: FinchAPI::Internal::ResponsesPage, - model: FinchAPI::Models::HRIS::IndividualResponse, + model: FinchAPI::HRIS::IndividualResponse, options: options ) end diff --git a/lib/finch_api/resources/hris/pay_statements.rb b/lib/finch_api/resources/hris/pay_statements.rb index 6ef7c846..7f396a87 100644 --- a/lib/finch_api/resources/hris/pay_statements.rb +++ b/lib/finch_api/resources/hris/pay_statements.rb @@ -11,21 +11,21 @@ class PayStatements # # @overload retrieve_many(requests:, request_options: {}) # - # @param requests [Array] The array of batch requests. + # @param requests [Array] The array of batch requests. # # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil] # - # @return [FinchAPI::Internal::ResponsesPage] + # @return [FinchAPI::Internal::ResponsesPage] # # @see FinchAPI::Models::HRIS::PayStatementRetrieveManyParams def retrieve_many(params) - parsed, options = FinchAPI::Models::HRIS::PayStatementRetrieveManyParams.dump_request(params) + parsed, options = FinchAPI::HRIS::PayStatementRetrieveManyParams.dump_request(params) @client.request( method: :post, path: "employer/pay-statement", body: parsed, page: FinchAPI::Internal::ResponsesPage, - model: FinchAPI::Models::HRIS::PayStatementResponse, + model: FinchAPI::HRIS::PayStatementResponse, options: options ) end diff --git a/lib/finch_api/resources/hris/payments.rb b/lib/finch_api/resources/hris/payments.rb index 8309cb79..8ab2b29d 100644 --- a/lib/finch_api/resources/hris/payments.rb +++ b/lib/finch_api/resources/hris/payments.rb @@ -12,24 +12,22 @@ class Payments # @overload list(end_date:, start_date:, request_options: {}) # # @param end_date [Date] The end date to retrieve payments by a company (inclusive) in `YYYY-MM-DD` forma - # ... # # @param start_date [Date] The start date to retrieve payments by a company (inclusive) in `YYYY-MM-DD` for - # ... # # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil] # - # @return [FinchAPI::Internal::SinglePage] + # @return [FinchAPI::Internal::SinglePage] # # @see FinchAPI::Models::HRIS::PaymentListParams def list(params) - parsed, options = FinchAPI::Models::HRIS::PaymentListParams.dump_request(params) + parsed, options = FinchAPI::HRIS::PaymentListParams.dump_request(params) @client.request( method: :get, path: "employer/payment", query: parsed, page: FinchAPI::Internal::SinglePage, - model: FinchAPI::Models::HRIS::Payment, + model: FinchAPI::HRIS::Payment, options: options ) end diff --git a/lib/finch_api/resources/jobs/automated.rb b/lib/finch_api/resources/jobs/automated.rb index be320175..78bdc16b 100644 --- a/lib/finch_api/resources/jobs/automated.rb +++ b/lib/finch_api/resources/jobs/automated.rb @@ -21,9 +21,9 @@ class Automated # # @overload create(type:, params:, request_options: {}) # - # @param type [Symbol, FinchAPI::Models::Jobs::AutomatedCreateParams::Type] The type of job to start. + # @param type [Symbol, FinchAPI::Jobs::AutomatedCreateParams::Type] The type of job to start. # - # @param params [FinchAPI::Models::Jobs::AutomatedCreateParams::Params] + # @param params [FinchAPI::Jobs::AutomatedCreateParams::Params] # # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil] # @@ -31,7 +31,7 @@ class Automated # # @see FinchAPI::Models::Jobs::AutomatedCreateParams def create(params) - parsed, options = FinchAPI::Models::Jobs::AutomatedCreateParams.dump_request(params) + parsed, options = FinchAPI::Jobs::AutomatedCreateParams.dump_request(params) @client.request( method: :post, path: "jobs/automated", @@ -48,14 +48,14 @@ def create(params) # @param job_id [String] # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil] # - # @return [FinchAPI::Models::Jobs::AutomatedAsyncJob] + # @return [FinchAPI::Jobs::AutomatedAsyncJob] # # @see FinchAPI::Models::Jobs::AutomatedRetrieveParams def retrieve(job_id, params = {}) @client.request( method: :get, path: ["jobs/automated/%1$s", job_id], - model: FinchAPI::Models::Jobs::AutomatedAsyncJob, + model: FinchAPI::Jobs::AutomatedAsyncJob, options: params[:request_options] ) end @@ -76,7 +76,7 @@ def retrieve(job_id, params = {}) # # @see FinchAPI::Models::Jobs::AutomatedListParams def list(params = {}) - parsed, options = FinchAPI::Models::Jobs::AutomatedListParams.dump_request(params) + parsed, options = FinchAPI::Jobs::AutomatedListParams.dump_request(params) @client.request( method: :get, path: "jobs/automated", diff --git a/lib/finch_api/resources/jobs/manual.rb b/lib/finch_api/resources/jobs/manual.rb index c591382c..7e621736 100644 --- a/lib/finch_api/resources/jobs/manual.rb +++ b/lib/finch_api/resources/jobs/manual.rb @@ -12,14 +12,14 @@ class Manual # @param job_id [String] # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil] # - # @return [FinchAPI::Models::Jobs::ManualAsyncJob] + # @return [FinchAPI::Jobs::ManualAsyncJob] # # @see FinchAPI::Models::Jobs::ManualRetrieveParams def retrieve(job_id, params = {}) @client.request( method: :get, path: ["jobs/manual/%1$s", job_id], - model: FinchAPI::Models::Jobs::ManualAsyncJob, + model: FinchAPI::Jobs::ManualAsyncJob, options: params[:request_options] ) end diff --git a/lib/finch_api/resources/payroll/pay_groups.rb b/lib/finch_api/resources/payroll/pay_groups.rb index b896dccc..dca6e3cb 100644 --- a/lib/finch_api/resources/payroll/pay_groups.rb +++ b/lib/finch_api/resources/payroll/pay_groups.rb @@ -35,7 +35,7 @@ def retrieve(pay_group_id, params = {}) # # @see FinchAPI::Models::Payroll::PayGroupListParams def list(params = {}) - parsed, options = FinchAPI::Models::Payroll::PayGroupListParams.dump_request(params) + parsed, options = FinchAPI::Payroll::PayGroupListParams.dump_request(params) @client.request( method: :get, path: "employer/pay-groups", diff --git a/lib/finch_api/resources/providers.rb b/lib/finch_api/resources/providers.rb index 3f22475f..aa6df226 100644 --- a/lib/finch_api/resources/providers.rb +++ b/lib/finch_api/resources/providers.rb @@ -9,7 +9,7 @@ class Providers # # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil] # - # @return [FinchAPI::Internal::SinglePage] + # @return [FinchAPI::Internal::SinglePage] # # @see FinchAPI::Models::ProviderListParams def list(params = {}) @@ -17,7 +17,7 @@ def list(params = {}) method: :get, path: "providers", page: FinchAPI::Internal::SinglePage, - model: FinchAPI::Models::Provider, + model: FinchAPI::Provider, options: params[:request_options] ) end diff --git a/lib/finch_api/resources/request_forwarding.rb b/lib/finch_api/resources/request_forwarding.rb index 244d606a..9daf553b 100644 --- a/lib/finch_api/resources/request_forwarding.rb +++ b/lib/finch_api/resources/request_forwarding.rb @@ -14,19 +14,14 @@ class RequestForwarding # @overload forward(method_:, route:, data: nil, headers: nil, params: nil, request_options: {}) # # @param method_ [String] The HTTP method for the forwarded request. Valid values include: `GET` , `POST` - # ... # # @param route [String] The URL route path for the forwarded request. This value must begin with a forwa - # ... # # @param data [String, nil] The body for the forwarded request. This value must be specified as either a str - # ... # # @param headers [Object, nil] The HTTP headers to include on the forwarded request. This value must be specifi - # ... # # @param params [Object, nil] The query parameters for the forwarded request. This value must be specified as - # ... # # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil] # @@ -34,7 +29,7 @@ class RequestForwarding # # @see FinchAPI::Models::RequestForwardingForwardParams def forward(params) - parsed, options = FinchAPI::Models::RequestForwardingForwardParams.dump_request(params) + parsed, options = FinchAPI::RequestForwardingForwardParams.dump_request(params) @client.request( method: :post, path: "forward", diff --git a/lib/finch_api/resources/sandbox/company.rb b/lib/finch_api/resources/sandbox/company.rb index 90cbe1ed..ba4127c7 100644 --- a/lib/finch_api/resources/sandbox/company.rb +++ b/lib/finch_api/resources/sandbox/company.rb @@ -11,22 +11,21 @@ class Company # # @overload update(accounts:, departments:, ein:, entity:, legal_name:, locations:, primary_email:, primary_phone_number:, request_options: {}) # - # @param accounts [Array, nil] An array of bank account objects associated with the payroll/HRIS system. + # @param accounts [Array, nil] An array of bank account objects associated with the payroll/HRIS system. # - # @param departments [Array, nil] The array of company departments. + # @param departments [Array, nil] The array of company departments. # # @param ein [String, nil] The employer identification number. # - # @param entity [FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity, nil] The entity type object. + # @param entity [FinchAPI::Sandbox::CompanyUpdateParams::Entity, nil] The entity type object. # # @param legal_name [String, nil] The legal name of the company. # - # @param locations [Array, nil] + # @param locations [Array, nil] # # @param primary_email [String, nil] The email of the main administrator on the account. # # @param primary_phone_number [String, nil] The phone number of the main administrator on the account. Format: E.164, with e - # ... # # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil] # @@ -34,7 +33,7 @@ class Company # # @see FinchAPI::Models::Sandbox::CompanyUpdateParams def update(params) - parsed, options = FinchAPI::Models::Sandbox::CompanyUpdateParams.dump_request(params) + parsed, options = FinchAPI::Sandbox::CompanyUpdateParams.dump_request(params) @client.request( method: :put, path: "sandbox/company", diff --git a/lib/finch_api/resources/sandbox/connections.rb b/lib/finch_api/resources/sandbox/connections.rb index cf6fba3e..3be6fe42 100644 --- a/lib/finch_api/resources/sandbox/connections.rb +++ b/lib/finch_api/resources/sandbox/connections.rb @@ -16,10 +16,9 @@ class Connections # # @param provider_id [String] The provider associated with the connection # - # @param authentication_type [Symbol, FinchAPI::Models::Sandbox::ConnectionCreateParams::AuthenticationType] + # @param authentication_type [Symbol, FinchAPI::Sandbox::ConnectionCreateParams::AuthenticationType] # # @param employee_size [Integer] Optional: the size of the employer to be created with this connection. Defaults - # ... # # @param products [Array] # @@ -29,7 +28,7 @@ class Connections # # @see FinchAPI::Models::Sandbox::ConnectionCreateParams def create(params) - parsed, options = FinchAPI::Models::Sandbox::ConnectionCreateParams.dump_request(params) + parsed, options = FinchAPI::Sandbox::ConnectionCreateParams.dump_request(params) @client.request( method: :post, path: "sandbox/connections", diff --git a/lib/finch_api/resources/sandbox/connections/accounts.rb b/lib/finch_api/resources/sandbox/connections/accounts.rb index ac39037b..56f4c836 100644 --- a/lib/finch_api/resources/sandbox/connections/accounts.rb +++ b/lib/finch_api/resources/sandbox/connections/accounts.rb @@ -16,10 +16,9 @@ class Accounts # # @param provider_id [String] The provider associated with the `access_token` # - # @param authentication_type [Symbol, FinchAPI::Models::Sandbox::Connections::AccountCreateParams::AuthenticationType] + # @param authentication_type [Symbol, FinchAPI::Sandbox::Connections::AccountCreateParams::AuthenticationType] # # @param products [Array] Optional, defaults to Organization products (`company`, `directory`, `employment - # ... # # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil] # @@ -27,7 +26,7 @@ class Accounts # # @see FinchAPI::Models::Sandbox::Connections::AccountCreateParams def create(params) - parsed, options = FinchAPI::Models::Sandbox::Connections::AccountCreateParams.dump_request(params) + parsed, options = FinchAPI::Sandbox::Connections::AccountCreateParams.dump_request(params) @client.request( method: :post, path: "sandbox/connections/accounts", @@ -42,14 +41,14 @@ def create(params) # # @overload update(connection_status: nil, request_options: {}) # - # @param connection_status [Symbol, FinchAPI::Models::ConnectionStatusType] + # @param connection_status [Symbol, FinchAPI::ConnectionStatusType] # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [FinchAPI::Models::Sandbox::Connections::AccountUpdateResponse] # # @see FinchAPI::Models::Sandbox::Connections::AccountUpdateParams def update(params = {}) - parsed, options = FinchAPI::Models::Sandbox::Connections::AccountUpdateParams.dump_request(params) + parsed, options = FinchAPI::Sandbox::Connections::AccountUpdateParams.dump_request(params) @client.request( method: :put, path: "sandbox/connections/accounts", diff --git a/lib/finch_api/resources/sandbox/directory.rb b/lib/finch_api/resources/sandbox/directory.rb index 3f5616c0..8db76f7f 100644 --- a/lib/finch_api/resources/sandbox/directory.rb +++ b/lib/finch_api/resources/sandbox/directory.rb @@ -11,8 +11,7 @@ class Directory # # @overload create(body: nil, request_options: {}) # - # @param body [Array] Array of individuals to create. Takes all combined fields from `/individual` and - # ... + # @param body [Array] Array of individuals to create. Takes all combined fields from `/individual` and # # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil] # @@ -20,7 +19,7 @@ class Directory # # @see FinchAPI::Models::Sandbox::DirectoryCreateParams def create(params = {}) - parsed, options = FinchAPI::Models::Sandbox::DirectoryCreateParams.dump_request(params) + parsed, options = FinchAPI::Sandbox::DirectoryCreateParams.dump_request(params) @client.request( method: :post, path: "sandbox/directory", diff --git a/lib/finch_api/resources/sandbox/employment.rb b/lib/finch_api/resources/sandbox/employment.rb index 8cebfdce..787fe7ce 100644 --- a/lib/finch_api/resources/sandbox/employment.rb +++ b/lib/finch_api/resources/sandbox/employment.rb @@ -15,23 +15,21 @@ class Employment # # @param class_code [String, nil] Worker's compensation classification code for this employee # - # @param custom_fields [Array] Custom fields for the individual. These are fields which are defined by the empl - # ... + # @param custom_fields [Array] Custom fields for the individual. These are fields which are defined by the empl # - # @param department [FinchAPI::Models::Sandbox::EmploymentUpdateParams::Department, nil] The department object. + # @param department [FinchAPI::Sandbox::EmploymentUpdateParams::Department, nil] The department object. # - # @param employment [FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment, nil] The employment object. + # @param employment [FinchAPI::Sandbox::EmploymentUpdateParams::Employment, nil] The employment object. # - # @param employment_status [Symbol, FinchAPI::Models::Sandbox::EmploymentUpdateParams::EmploymentStatus, nil] The detailed employment status of the individual. + # @param employment_status [Symbol, FinchAPI::Sandbox::EmploymentUpdateParams::EmploymentStatus, nil] The detailed employment status of the individual. # # @param end_date [String, nil] # # @param first_name [String, nil] The legal first name of the individual. # - # @param income [FinchAPI::Models::Income, nil] The employee's income as reported by the provider. This may not always be annual - # ... + # @param income [FinchAPI::Income, nil] The employee's income as reported by the provider. This may not always be annual # - # @param income_history [Array, nil] The array of income history. + # @param income_history [Array, nil] The array of income history. # # @param is_active [Boolean, nil] `true` if the individual an an active employee or contractor at the company. # @@ -39,9 +37,9 @@ class Employment # # @param latest_rehire_date [String, nil] # - # @param location [FinchAPI::Models::Location, nil] + # @param location [FinchAPI::Location, nil] # - # @param manager [FinchAPI::Models::Sandbox::EmploymentUpdateParams::Manager, nil] The manager object representing the manager of the individual within the org. + # @param manager [FinchAPI::Sandbox::EmploymentUpdateParams::Manager, nil] The manager object representing the manager of the individual within the org. # # @param middle_name [String, nil] The legal middle name of the individual. # @@ -57,7 +55,7 @@ class Employment # # @see FinchAPI::Models::Sandbox::EmploymentUpdateParams def update(individual_id, params = {}) - parsed, options = FinchAPI::Models::Sandbox::EmploymentUpdateParams.dump_request(params) + parsed, options = FinchAPI::Sandbox::EmploymentUpdateParams.dump_request(params) @client.request( method: :put, path: ["sandbox/employment/%1$s", individual_id], diff --git a/lib/finch_api/resources/sandbox/individual.rb b/lib/finch_api/resources/sandbox/individual.rb index d35a783d..5beb75ce 100644 --- a/lib/finch_api/resources/sandbox/individual.rb +++ b/lib/finch_api/resources/sandbox/individual.rb @@ -15,29 +15,27 @@ class Individual # # @param dob [String, nil] # - # @param emails [Array, nil] + # @param emails [Array, nil] # # @param encrypted_ssn [String, nil] Social Security Number of the individual in **encrypted** format. This field is - # ... # - # @param ethnicity [Symbol, FinchAPI::Models::Sandbox::IndividualUpdateParams::Ethnicity, nil] The EEOC-defined ethnicity of the individual. + # @param ethnicity [Symbol, FinchAPI::Sandbox::IndividualUpdateParams::Ethnicity, nil] The EEOC-defined ethnicity of the individual. # # @param first_name [String, nil] The legal first name of the individual. # - # @param gender [Symbol, FinchAPI::Models::Sandbox::IndividualUpdateParams::Gender, nil] The gender of the individual. + # @param gender [Symbol, FinchAPI::Sandbox::IndividualUpdateParams::Gender, nil] The gender of the individual. # # @param last_name [String, nil] The legal last name of the individual. # # @param middle_name [String, nil] The legal middle name of the individual. # - # @param phone_numbers [Array, nil] + # @param phone_numbers [Array, nil] # # @param preferred_name [String, nil] The preferred name of the individual. # - # @param residence [FinchAPI::Models::Location, nil] + # @param residence [FinchAPI::Location, nil] # # @param ssn [String, nil] Social Security Number of the individual. This field is only available with the - # ... # # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil] # @@ -45,7 +43,7 @@ class Individual # # @see FinchAPI::Models::Sandbox::IndividualUpdateParams def update(individual_id, params = {}) - parsed, options = FinchAPI::Models::Sandbox::IndividualUpdateParams.dump_request(params) + parsed, options = FinchAPI::Sandbox::IndividualUpdateParams.dump_request(params) @client.request( method: :put, path: ["sandbox/individual/%1$s", individual_id], diff --git a/lib/finch_api/resources/sandbox/jobs.rb b/lib/finch_api/resources/sandbox/jobs.rb index 822ad5f2..da2862bd 100644 --- a/lib/finch_api/resources/sandbox/jobs.rb +++ b/lib/finch_api/resources/sandbox/jobs.rb @@ -11,7 +11,7 @@ class Jobs # # @overload create(type:, request_options: {}) # - # @param type [Symbol, FinchAPI::Models::Sandbox::JobCreateParams::Type] The type of job to start. Currently the only supported type is `data_sync_all` + # @param type [Symbol, FinchAPI::Sandbox::JobCreateParams::Type] The type of job to start. Currently the only supported type is `data_sync_all` # # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil] # @@ -19,7 +19,7 @@ class Jobs # # @see FinchAPI::Models::Sandbox::JobCreateParams def create(params) - parsed, options = FinchAPI::Models::Sandbox::JobCreateParams.dump_request(params) + parsed, options = FinchAPI::Sandbox::JobCreateParams.dump_request(params) @client.request( method: :post, path: "sandbox/jobs", diff --git a/lib/finch_api/resources/sandbox/jobs/configuration.rb b/lib/finch_api/resources/sandbox/jobs/configuration.rb index 00b07bf3..f5b38d21 100644 --- a/lib/finch_api/resources/sandbox/jobs/configuration.rb +++ b/lib/finch_api/resources/sandbox/jobs/configuration.rb @@ -11,14 +11,14 @@ class Configuration # # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil] # - # @return [Array] + # @return [Array] # # @see FinchAPI::Models::Sandbox::Jobs::ConfigurationRetrieveParams def retrieve(params = {}) @client.request( method: :get, path: "sandbox/jobs/configuration", - model: FinchAPI::Internal::Type::ArrayOf[FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration], + model: FinchAPI::Internal::Type::ArrayOf[FinchAPI::Sandbox::Jobs::SandboxJobConfiguration], options: params[:request_options] ) end @@ -27,20 +27,20 @@ def retrieve(params = {}) # # @overload update(completion_status:, type:, request_options: {}) # - # @param completion_status [Symbol, FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration::CompletionStatus] - # @param type [Symbol, FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration::Type] + # @param completion_status [Symbol, FinchAPI::Sandbox::Jobs::SandboxJobConfiguration::CompletionStatus] + # @param type [Symbol, FinchAPI::Sandbox::Jobs::SandboxJobConfiguration::Type] # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil] # - # @return [FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration] + # @return [FinchAPI::Sandbox::Jobs::SandboxJobConfiguration] # # @see FinchAPI::Models::Sandbox::Jobs::ConfigurationUpdateParams def update(params) - parsed, options = FinchAPI::Models::Sandbox::Jobs::ConfigurationUpdateParams.dump_request(params) + parsed, options = FinchAPI::Sandbox::Jobs::ConfigurationUpdateParams.dump_request(params) @client.request( method: :put, path: "sandbox/jobs/configuration", body: parsed, - model: FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration, + model: FinchAPI::Sandbox::Jobs::SandboxJobConfiguration, options: options ) end diff --git a/lib/finch_api/resources/sandbox/payment.rb b/lib/finch_api/resources/sandbox/payment.rb index e9c982f0..d778e15f 100644 --- a/lib/finch_api/resources/sandbox/payment.rb +++ b/lib/finch_api/resources/sandbox/payment.rb @@ -9,7 +9,7 @@ class Payment # @overload create(end_date: nil, pay_statements: nil, start_date: nil, request_options: {}) # # @param end_date [String] - # @param pay_statements [Array] + # @param pay_statements [Array] # @param start_date [String] # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil] # @@ -17,7 +17,7 @@ class Payment # # @see FinchAPI::Models::Sandbox::PaymentCreateParams def create(params = {}) - parsed, options = FinchAPI::Models::Sandbox::PaymentCreateParams.dump_request(params) + parsed, options = FinchAPI::Sandbox::PaymentCreateParams.dump_request(params) @client.request( method: :post, path: "sandbox/payment", diff --git a/lib/finch_api/version.rb b/lib/finch_api/version.rb index 54901568..470e5eff 100644 --- a/lib/finch_api/version.rb +++ b/lib/finch_api/version.rb @@ -1,5 +1,5 @@ # frozen_string_literal: true module FinchAPI - VERSION = "0.1.0.pre.alpha.13" + VERSION = "0.1.0.pre.alpha.14" end diff --git a/rbi/finch_api/client.rbi b/rbi/finch_api/client.rbi index 2033f8b4..4c795423 100644 --- a/rbi/finch_api/client.rbi +++ b/rbi/finch_api/client.rbi @@ -51,15 +51,18 @@ module FinchAPI # @api private sig { override.returns(T::Hash[String, String]) } - private def auth_headers; end + private def auth_headers + end # @api private sig { returns(T::Hash[String, String]) } - private def bearer_auth; end + private def bearer_auth + end # @api private sig { returns(T::Hash[String, String]) } - private def basic_auth; end + private def basic_auth + end # Creates and returns a new client for interacting with the API. sig do @@ -72,8 +75,7 @@ module FinchAPI timeout: Float, initial_retry_delay: Float, max_retry_delay: Float - ) - .returns(T.attached_class) + ).returns(T.attached_class) end def self.new( # Defaults to `ENV["FINCH_CLIENT_ID"]` @@ -89,6 +91,7 @@ module FinchAPI timeout: FinchAPI::Client::DEFAULT_TIMEOUT_IN_SECONDS, initial_retry_delay: FinchAPI::Client::DEFAULT_INITIAL_RETRY_DELAY, max_retry_delay: FinchAPI::Client::DEFAULT_MAX_RETRY_DELAY - ); end + ) + end end end diff --git a/rbi/finch_api/errors.rbi b/rbi/finch_api/errors.rbi index 3a112459..205195c6 100644 --- a/rbi/finch_api/errors.rbi +++ b/rbi/finch_api/errors.rbi @@ -29,10 +29,17 @@ module FinchAPI request: NilClass, response: NilClass, message: T.nilable(String) - ) - .returns(T.attached_class) + ).returns(T.attached_class) + end + def self.new( + url:, + status: nil, + body: nil, + request: nil, + response: nil, + message: nil + ) end - def self.new(url:, status: nil, body: nil, request: nil, response: nil, message: nil); end end class APIConnectionError < FinchAPI::Errors::APIError @@ -51,10 +58,16 @@ module FinchAPI request: NilClass, response: NilClass, message: T.nilable(String) - ) - .returns(T.attached_class) + ).returns(T.attached_class) end - def self.new(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 @@ -68,10 +81,16 @@ module FinchAPI request: NilClass, response: NilClass, message: T.nilable(String) - ) - .returns(T.attached_class) + ).returns(T.attached_class) end - def self.new(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 @@ -85,10 +104,10 @@ module FinchAPI request: NilClass, response: NilClass, message: T.nilable(String) - ) - .returns(T.attached_class) + ).returns(T.attached_class) + end + def self.for(url:, status:, body:, request:, response:, message: nil) end - def self.for(url:, status:, body:, request:, response:, message: nil); end sig { returns(Integer) } attr_accessor :status @@ -102,10 +121,10 @@ module FinchAPI request: NilClass, response: NilClass, message: T.nilable(String) - ) - .returns(T.attached_class) + ).returns(T.attached_class) + end + def self.new(url:, status:, body:, request:, response:, message: nil) end - def self.new(url:, status:, body:, request:, response:, message: nil); end end class BadRequestError < FinchAPI::Errors::APIStatusError diff --git a/rbi/finch_api/file_part.rbi b/rbi/finch_api/file_part.rbi index 4d9108e5..93b8cfd5 100644 --- a/rbi/finch_api/file_part.rbi +++ b/rbi/finch_api/file_part.rbi @@ -13,22 +13,25 @@ module FinchAPI # @api private sig { returns(String) } - private def read; end + private def read + end sig { params(a: T.anything).returns(String) } - def to_json(*a); end + def to_json(*a) + end sig { params(a: T.anything).returns(String) } - def to_yaml(*a); end + def to_yaml(*a) + end sig do params( content: T.any(Pathname, StringIO, IO, String), filename: T.nilable(String), content_type: T.nilable(String) - ) - .returns(T.attached_class) + ).returns(T.attached_class) + end + def self.new(content, filename: nil, content_type: nil) end - def self.new(content, filename: nil, content_type: nil); end end end diff --git a/rbi/finch_api/internal/individuals_page.rbi b/rbi/finch_api/internal/individuals_page.rbi index 4446c707..fc3359da 100644 --- a/rbi/finch_api/internal/individuals_page.rbi +++ b/rbi/finch_api/internal/individuals_page.rbi @@ -10,12 +10,13 @@ module FinchAPI sig { returns(T.nilable(T::Array[Elem])) } attr_accessor :individuals - sig { returns(FinchAPI::Models::Paging) } + sig { returns(FinchAPI::Paging) } attr_accessor :paging # @api private sig { returns(String) } - def inspect; end + def inspect + end end end end diff --git a/rbi/finch_api/internal/page.rbi b/rbi/finch_api/internal/page.rbi index ed1e89d2..e4e1e083 100644 --- a/rbi/finch_api/internal/page.rbi +++ b/rbi/finch_api/internal/page.rbi @@ -10,12 +10,13 @@ module FinchAPI sig { returns(T.nilable(T::Array[Elem])) } attr_accessor :data - sig { returns(FinchAPI::Models::Paging) } + sig { returns(FinchAPI::Paging) } attr_accessor :paging # @api private sig { returns(String) } - def inspect; end + def inspect + end end end end diff --git a/rbi/finch_api/internal/responses_page.rbi b/rbi/finch_api/internal/responses_page.rbi index 9985f5a2..1e355dfa 100644 --- a/rbi/finch_api/internal/responses_page.rbi +++ b/rbi/finch_api/internal/responses_page.rbi @@ -12,7 +12,8 @@ module FinchAPI # @api private sig { returns(String) } - def inspect; end + def inspect + end end end end diff --git a/rbi/finch_api/internal/single_page.rbi b/rbi/finch_api/internal/single_page.rbi index 6c407582..b8ba0404 100644 --- a/rbi/finch_api/internal/single_page.rbi +++ b/rbi/finch_api/internal/single_page.rbi @@ -8,17 +8,21 @@ module FinchAPI Elem = type_member sig { override.returns(T::Boolean) } - def next_page?; end + def next_page? + end sig { override.returns(T.self_type) } - def next_page; end + def next_page + end sig { override.params(blk: T.proc.params(arg0: Elem).void).void } - def auto_paging_each(&blk); end + def auto_paging_each(&blk) + end # @api private sig { returns(String) } - def inspect; end + def inspect + end end end end diff --git a/rbi/finch_api/internal/transport/base_client.rbi b/rbi/finch_api/internal/transport/base_client.rbi index e2fbb421..176c8f89 100644 --- a/rbi/finch_api/internal/transport/base_client.rbi +++ b/rbi/finch_api/internal/transport/base_client.rbi @@ -12,30 +12,44 @@ module FinchAPI { 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))] - ) - )] - ), + 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( - T.any( - Symbol, - Integer, - T::Array[T.any(Symbol, Integer)], - T.proc.params(arg0: T.anything).returns(T.anything) - ) - ), - page: T.nilable(T::Class[FinchAPI::Internal::Type::BasePage[FinchAPI::Internal::Type::BaseModel]]), + unwrap: + T.nilable( + T.any( + Symbol, + Integer, + T::Array[T.any(Symbol, Integer)], + T.proc.params(arg0: T.anything).returns(T.anything) + ) + ), + page: + T.nilable( + T::Class[ + FinchAPI::Internal::Type::BasePage[ + FinchAPI::Internal::Type::BaseModel + ] + ] + ), stream: T.nilable(T::Class[T.anything]), model: T.nilable(FinchAPI::Internal::Type::Converter::Input), - options: T.nilable(FinchAPI::RequestOpts) + options: T.nilable(FinchAPI::RequestOptions::OrHash) } end @@ -58,41 +72,48 @@ module FinchAPI class << self # @api private - sig { params(req: FinchAPI::Internal::Transport::BaseClient::RequestComponentsShape).void } - def validate!(req); end + sig do + params( + req: + FinchAPI::Internal::Transport::BaseClient::RequestComponentsShape + ).void + end + def validate!(req) + end # @api private sig do params( status: Integer, - headers: T.any( - T::Hash[String, String], - Net::HTTPHeader - ) + headers: T.any(T::Hash[String, String], Net::HTTPHeader) ).returns(T::Boolean) end - def should_retry?(status, headers:); end + def should_retry?(status, headers:) + end # @api private sig do params( - request: FinchAPI::Internal::Transport::BaseClient::RequestInputShape, + request: + FinchAPI::Internal::Transport::BaseClient::RequestInputShape, status: Integer, response_headers: T.any(T::Hash[String, String], Net::HTTPHeader) + ).returns( + FinchAPI::Internal::Transport::BaseClient::RequestInputShape ) - .returns(FinchAPI::Internal::Transport::BaseClient::RequestInputShape) end - def follow_redirect(request, status:, response_headers:); end + def follow_redirect(request, status:, response_headers:) + end # @api private sig do params( status: T.any(Integer, FinchAPI::Errors::APIConnectionError), stream: T.nilable(T::Enumerable[String]) - ) - .void + ).void + end + def reap_connection!(status, stream:) end - def reap_connection!(status, stream:); end end # @api private @@ -107,11 +128,19 @@ module FinchAPI max_retries: Integer, initial_retry_delay: Float, max_retry_delay: Float, - headers: T::Hash[String, - T.nilable(T.any(String, Integer, T::Array[T.nilable(T.any(String, Integer))]))], + headers: + T::Hash[ + String, + T.nilable( + T.any( + String, + Integer, + T::Array[T.nilable(T.any(String, Integer))] + ) + ) + ], idempotency_header: T.nilable(String) - ) - .returns(T.attached_class) + ).returns(T.attached_class) end def self.new( base_url:, @@ -121,41 +150,61 @@ module FinchAPI max_retry_delay: 0.0, headers: {}, idempotency_header: nil - ); end + ) + end + # @api private sig { overridable.returns(T::Hash[String, String]) } - private def auth_headers; end + private def auth_headers + end # @api private sig { returns(String) } - private def generate_idempotency_key; end + private def generate_idempotency_key + end # @api private sig do overridable .params( - req: FinchAPI::Internal::Transport::BaseClient::RequestComponentsShape, + req: + FinchAPI::Internal::Transport::BaseClient::RequestComponentsShape, opts: FinchAPI::Internal::AnyHash ) - .returns(FinchAPI::Internal::Transport::BaseClient::RequestInputShape) + .returns( + FinchAPI::Internal::Transport::BaseClient::RequestInputShape + ) + end + private def build_request(req, opts) end - 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 + sig do + params( + headers: T::Hash[String, String], + retry_count: Integer + ).returns(Float) + end + private def retry_delay(headers, retry_count:) + end # @api private sig do params( - request: FinchAPI::Internal::Transport::BaseClient::RequestInputShape, + request: + FinchAPI::Internal::Transport::BaseClient::RequestInputShape, redirect_count: Integer, retry_count: Integer, send_retry_header: T::Boolean - ) - .returns([Integer, Net::HTTPResponse, T::Enumerable[String]]) + ).returns([Integer, Net::HTTPResponse, T::Enumerable[String]]) + end + private def send_request( + request, + redirect_count:, + retry_count:, + send_retry_header: + ) end - 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. @@ -165,32 +214,45 @@ module FinchAPI params( 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))] - ) - )] - ), + 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( - T.any( - Symbol, - Integer, - T::Array[T.any(Symbol, Integer)], - T.proc.params(arg0: T.anything).returns(T.anything) - ) - ), - page: T.nilable(T::Class[FinchAPI::Internal::Type::BasePage[FinchAPI::Internal::Type::BaseModel]]), + unwrap: + T.nilable( + T.any( + Symbol, + Integer, + T::Array[T.any(Symbol, Integer)], + T.proc.params(arg0: T.anything).returns(T.anything) + ) + ), + page: + T.nilable( + T::Class[ + FinchAPI::Internal::Type::BasePage[ + FinchAPI::Internal::Type::BaseModel + ] + ] + ), stream: T.nilable(T::Class[T.anything]), model: T.nilable(FinchAPI::Internal::Type::Converter::Input), - options: T.nilable(FinchAPI::RequestOpts) - ) - .returns(T.anything) + options: T.nilable(FinchAPI::RequestOptions::OrHash) + ).returns(T.anything) end def request( method, @@ -203,10 +265,13 @@ module FinchAPI stream: nil, model: FinchAPI::Internal::Type::Unknown, options: {} - ); end + ) + end + # @api private sig { returns(String) } - def inspect; end + def inspect + end end end end diff --git a/rbi/finch_api/internal/transport/pooled_net_requester.rbi b/rbi/finch_api/internal/transport/pooled_net_requester.rbi index cf097783..c44047ea 100644 --- a/rbi/finch_api/internal/transport/pooled_net_requester.rbi +++ b/rbi/finch_api/internal/transport/pooled_net_requester.rbi @@ -23,37 +23,51 @@ module FinchAPI class << self # @api private sig { params(url: URI::Generic).returns(Net::HTTP) } - def connect(url); end + def connect(url) + end # @api private sig { params(conn: Net::HTTP, deadline: Float).void } - def calibrate_socket_timeout(conn, deadline); end + def calibrate_socket_timeout(conn, deadline) + end # @api private sig do params( - request: FinchAPI::Internal::Transport::PooledNetRequester::RequestShape, + request: + FinchAPI::Internal::Transport::PooledNetRequester::RequestShape, blk: T.proc.params(arg0: String).void - ) - .returns([Net::HTTPGenericRequest, T.proc.void]) + ).returns([Net::HTTPGenericRequest, T.proc.void]) + end + def build_request(request, &blk) end - def build_request(request, &blk); end end # @api private - sig { params(url: URI::Generic, deadline: Float, blk: T.proc.params(arg0: Net::HTTP).void).void } - private def with_pool(url, deadline:, &blk); end + sig do + params( + url: URI::Generic, + deadline: Float, + blk: T.proc.params(arg0: Net::HTTP).void + ).void + end + private def with_pool(url, deadline:, &blk) + end # @api private sig do - params(request: FinchAPI::Internal::Transport::PooledNetRequester::RequestShape) - .returns([Integer, Net::HTTPResponse, T::Enumerable[String]]) + params( + request: + FinchAPI::Internal::Transport::PooledNetRequester::RequestShape + ).returns([Integer, Net::HTTPResponse, T::Enumerable[String]]) + end + def execute(request) end - def execute(request); end # @api private sig { params(size: Integer).returns(T.attached_class) } - def self.new(size: Etc.nprocessors); end + def self.new(size: Etc.nprocessors) + end end end end diff --git a/rbi/finch_api/internal/type/array_of.rbi b/rbi/finch_api/internal/type/array_of.rbi index ede086f7..06bfd1ee 100644 --- a/rbi/finch_api/internal/type/array_of.rbi +++ b/rbi/finch_api/internal/type/array_of.rbi @@ -15,25 +15,29 @@ module FinchAPI sig do params( - type_info: T.any( - FinchAPI::Internal::AnyHash, - T.proc.returns(FinchAPI::Internal::Type::Converter::Input), - FinchAPI::Internal::Type::Converter::Input - ), + type_info: + T.any( + FinchAPI::Internal::AnyHash, + T.proc.returns(FinchAPI::Internal::Type::Converter::Input), + FinchAPI::Internal::Type::Converter::Input + ), spec: FinchAPI::Internal::AnyHash - ) - .returns(T.attached_class) + ).returns(T.attached_class) + end + def self.[](type_info, spec = {}) end - def self.[](type_info, spec = {}); end sig { params(other: T.anything).returns(T::Boolean) } - def ===(other); end + def ===(other) + end sig { params(other: T.anything).returns(T::Boolean) } - def ==(other); end + def ==(other) + end sig { returns(Integer) } - def hash; end + def hash + end # @api private sig do @@ -44,7 +48,8 @@ module FinchAPI ) .returns(T.any(T::Array[T.anything], T.anything)) end - def coerce(value, state:); end + def coerce(value, state:) + end # @api private sig do @@ -55,33 +60,38 @@ module FinchAPI ) .returns(T.any(T::Array[T.anything], T.anything)) end - def dump(value, state:); end + def dump(value, state:) + end # @api private sig { returns(Elem) } - protected def item_type; end + protected def item_type + end # @api private sig { returns(T::Boolean) } - protected def nilable?; end + protected def nilable? + end # @api private sig do params( - type_info: T.any( - FinchAPI::Internal::AnyHash, - T.proc.returns(FinchAPI::Internal::Type::Converter::Input), - FinchAPI::Internal::Type::Converter::Input - ), + type_info: + T.any( + FinchAPI::Internal::AnyHash, + T.proc.returns(FinchAPI::Internal::Type::Converter::Input), + FinchAPI::Internal::Type::Converter::Input + ), spec: FinchAPI::Internal::AnyHash - ) - .void + ).void + end + def initialize(type_info, spec = {}) end - def initialize(type_info, spec = {}); end # @api private sig { params(depth: Integer).returns(String) } - def inspect(depth: 0); end + def inspect(depth: 0) + end end end end diff --git a/rbi/finch_api/internal/type/base_model.rbi b/rbi/finch_api/internal/type/base_model.rbi index 52ec1fc0..8c2a8f6f 100644 --- a/rbi/finch_api/internal/type/base_model.rbi +++ b/rbi/finch_api/internal/type/base_model.rbi @@ -8,9 +8,17 @@ module FinchAPI abstract! - KnownFieldShape = T.type_alias do - {mode: T.nilable(Symbol), required: T::Boolean, nilable: T::Boolean} - end + KnownFieldShape = + T.type_alias do + { + mode: T.nilable(Symbol), + required: T::Boolean, + nilable: T::Boolean + } + end + + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } class << self # @api private @@ -23,12 +31,16 @@ module FinchAPI Symbol, T.all( FinchAPI::Internal::Type::BaseModel::KnownFieldShape, - {type_fn: T.proc.returns(FinchAPI::Internal::Type::Converter::Input)} + { + type_fn: + T.proc.returns(FinchAPI::Internal::Type::Converter::Input) + } ) ] ) end - def known_fields; end + def known_fields + end # @api private sig do @@ -37,118 +49,143 @@ module FinchAPI Symbol, T.all( FinchAPI::Internal::Type::BaseModel::KnownFieldShape, - {type: FinchAPI::Internal::Type::Converter::Input} + { type: FinchAPI::Internal::Type::Converter::Input } ) ] ) end - def fields; end + def fields + end # @api private 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::Internal::Type::Converter::Input)), - union: T.nilable(T.proc.returns(FinchAPI::Internal::Type::Converter::Input)), - api_name: Symbol, - nil?: T::Boolean - }, - T.proc.returns(FinchAPI::Internal::Type::Converter::Input), - FinchAPI::Internal::Type::Converter::Input - ), + type_info: + T.any( + { + const: + T.nilable( + T.any(NilClass, T::Boolean, Integer, Float, Symbol) + ), + enum: + T.nilable( + T.proc.returns( + FinchAPI::Internal::Type::Converter::Input + ) + ), + union: + T.nilable( + T.proc.returns( + FinchAPI::Internal::Type::Converter::Input + ) + ), + api_name: Symbol, + nil?: T::Boolean + }, + T.proc.returns(FinchAPI::Internal::Type::Converter::Input), + FinchAPI::Internal::Type::Converter::Input + ), spec: FinchAPI::Internal::AnyHash - ) - .void + ).void + end + private def add_field(name_sym, required:, type_info:, spec:) end - private def add_field(name_sym, required:, type_info:, spec:); end # @api private sig do params( name_sym: Symbol, - type_info: T.any( - FinchAPI::Internal::AnyHash, - T.proc.returns(FinchAPI::Internal::Type::Converter::Input), - FinchAPI::Internal::Type::Converter::Input - ), + type_info: + T.any( + FinchAPI::Internal::AnyHash, + T.proc.returns(FinchAPI::Internal::Type::Converter::Input), + FinchAPI::Internal::Type::Converter::Input + ), spec: FinchAPI::Internal::AnyHash - ) - .void + ).void + end + def required(name_sym, type_info, spec = {}) end - def required(name_sym, type_info, spec = {}); end # @api private sig do params( name_sym: Symbol, - type_info: T.any( - FinchAPI::Internal::AnyHash, - T.proc.returns(FinchAPI::Internal::Type::Converter::Input), - FinchAPI::Internal::Type::Converter::Input - ), + type_info: + T.any( + FinchAPI::Internal::AnyHash, + T.proc.returns(FinchAPI::Internal::Type::Converter::Input), + FinchAPI::Internal::Type::Converter::Input + ), spec: FinchAPI::Internal::AnyHash - ) - .void + ).void + end + def optional(name_sym, type_info, spec = {}) end - 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 + 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 + private def response_only(&blk) + end sig { params(other: T.anything).returns(T::Boolean) } - def ==(other); end + def ==(other) + end sig { returns(Integer) } - def hash; end + def hash + end end sig { params(other: T.anything).returns(T::Boolean) } - def ==(other); end + def ==(other) + end sig { returns(Integer) } - def hash; end + def hash + end class << self # @api private sig do override .params( - value: T.any( - FinchAPI::Internal::Type::BaseModel, - T::Hash[T.anything, T.anything], - T.anything - ), + value: + T.any( + FinchAPI::Internal::Type::BaseModel, + T::Hash[T.anything, T.anything], + T.anything + ), state: FinchAPI::Internal::Type::Converter::CoerceState ) .returns(T.any(T.attached_class, T.anything)) end - def coerce(value, state:); end + def coerce(value, state:) + end # @api private sig do override - .params(value: T.any( - T.attached_class, - T.anything - ), - state: FinchAPI::Internal::Type::Converter::DumpState) + .params( + value: T.any(T.attached_class, T.anything), + state: FinchAPI::Internal::Type::Converter::DumpState + ) .returns(T.any(T::Hash[T.anything, T.anything], T.anything)) end - def dump(value, state:); end + def dump(value, state:) + end end # Returns the raw value associated with the given key, if found. Otherwise, nil is @@ -158,7 +195,8 @@ module FinchAPI # 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 + def [](key) + end # Returns a Hash of the data underlying this object. O(1) # @@ -169,7 +207,8 @@ module FinchAPI # This method is not recursive. The returned value is shared by the object, so it # should not be mutated. sig { overridable.returns(FinchAPI::Internal::AnyHash) } - def to_h; end + def to_h + end # Returns a Hash of the data underlying this object. O(1) # @@ -180,39 +219,60 @@ module FinchAPI # This method is not recursive. The returned value is shared by the object, so it # should not be mutated. sig { overridable.returns(FinchAPI::Internal::AnyHash) } - def to_hash; end + def to_hash + end - sig { params(keys: T.nilable(T::Array[Symbol])).returns(FinchAPI::Internal::AnyHash) } - def deconstruct_keys(keys); end + sig do + params(keys: T.nilable(T::Array[Symbol])).returns( + FinchAPI::Internal::AnyHash + ) + end + def deconstruct_keys(keys) + end class << self # @api private - sig { params(model: FinchAPI::Internal::Type::BaseModel).returns(FinchAPI::Internal::AnyHash) } - def walk(model); end + sig do + params(model: FinchAPI::Internal::Type::BaseModel).returns( + FinchAPI::Internal::AnyHash + ) + end + def walk(model) + end end sig { params(a: T.anything).returns(String) } - def to_json(*a); end + def to_json(*a) + end sig { params(a: T.anything).returns(String) } - def to_yaml(*a); end + def to_yaml(*a) + 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 + sig do + params(data: T.any(T::Hash[Symbol, T.anything], T.self_type)).returns( + T.attached_class + ) + end + def self.new(data = {}) + end class << self # @api private sig { params(depth: Integer).returns(String) } - def inspect(depth: 0); end + def inspect(depth: 0) + end end sig { returns(String) } - def to_s; end + def to_s + end # @api private sig { returns(String) } - def inspect; end + def inspect + end end end end diff --git a/rbi/finch_api/internal/type/base_page.rbi b/rbi/finch_api/internal/type/base_page.rbi index 8f400a8f..7c4fef6e 100644 --- a/rbi/finch_api/internal/type/base_page.rbi +++ b/rbi/finch_api/internal/type/base_page.rbi @@ -10,28 +10,33 @@ module FinchAPI Elem = type_member(:out) sig { overridable.returns(T::Boolean) } - def next_page?; end + def next_page? + end sig { overridable.returns(T.self_type) } - def next_page; end + def next_page + end sig { overridable.params(blk: T.proc.params(arg0: Elem).void).void } - def auto_paging_each(&blk); end + def auto_paging_each(&blk) + end sig { returns(T::Enumerable[Elem]) } - def to_enum; end + def to_enum + end # @api private sig do params( client: FinchAPI::Internal::Transport::BaseClient, - req: FinchAPI::Internal::Transport::BaseClient::RequestComponentsShape, + req: + FinchAPI::Internal::Transport::BaseClient::RequestComponentsShape, headers: T.any(T::Hash[String, String], Net::HTTPHeader), page_data: T.anything - ) - .void + ).void + end + def initialize(client:, req:, headers:, page_data:) end - def initialize(client:, req:, headers:, page_data:); end end end end diff --git a/rbi/finch_api/internal/type/boolean.rbi b/rbi/finch_api/internal/type/boolean.rbi index b3bbeda4..e07554c5 100644 --- a/rbi/finch_api/internal/type/boolean.rbi +++ b/rbi/finch_api/internal/type/boolean.rbi @@ -12,35 +12,37 @@ module FinchAPI abstract! sig { params(other: T.anything).returns(T::Boolean) } - def self.===(other); end + def self.===(other) + end sig { params(other: T.anything).returns(T::Boolean) } - def self.==(other); end + def self.==(other) + end class << self # @api private sig do override - .params(value: T.any( - T::Boolean, - T.anything - ), - state: FinchAPI::Internal::Type::Converter::CoerceState) + .params( + value: T.any(T::Boolean, T.anything), + state: FinchAPI::Internal::Type::Converter::CoerceState + ) .returns(T.any(T::Boolean, T.anything)) end - def coerce(value, state:); end + def coerce(value, state:) + end # @api private sig do override - .params(value: T.any( - T::Boolean, - T.anything - ), - state: FinchAPI::Internal::Type::Converter::DumpState) + .params( + value: T.any(T::Boolean, T.anything), + state: FinchAPI::Internal::Type::Converter::DumpState + ) .returns(T.any(T::Boolean, T.anything)) end - def dump(value, state:); end + def dump(value, state:) + end end end end diff --git a/rbi/finch_api/internal/type/converter.rbi b/rbi/finch_api/internal/type/converter.rbi index d12c681e..2b559453 100644 --- a/rbi/finch_api/internal/type/converter.rbi +++ b/rbi/finch_api/internal/type/converter.rbi @@ -5,56 +5,86 @@ module FinchAPI module Type # @api private module Converter - Input = T.type_alias { T.any(FinchAPI::Internal::Type::Converter, T::Class[T.anything]) } + Input = + T.type_alias do + T.any(FinchAPI::Internal::Type::Converter, T::Class[T.anything]) + end CoerceState = T.type_alias do { strictness: T.any(T::Boolean, Symbol), - exactness: {yes: Integer, no: Integer, maybe: Integer}, + exactness: { + yes: Integer, + no: Integer, + maybe: Integer + }, branched: Integer } end - DumpState = T.type_alias { {can_retry: T::Boolean} } + DumpState = T.type_alias { { can_retry: T::Boolean } } # @api private sig do overridable - .params(value: T.anything, state: FinchAPI::Internal::Type::Converter::CoerceState) + .params( + value: T.anything, + state: FinchAPI::Internal::Type::Converter::CoerceState + ) .returns(T.anything) end - def coerce(value, state:); end + def coerce(value, state:) + end # @api private sig do overridable - .params(value: T.anything, state: FinchAPI::Internal::Type::Converter::DumpState) + .params( + value: T.anything, + state: FinchAPI::Internal::Type::Converter::DumpState + ) .returns(T.anything) end - def dump(value, state:); end + def dump(value, state:) + end # @api private sig { params(depth: Integer).returns(String) } - def inspect(depth: 0); end + def inspect(depth: 0) + end class << self # @api private sig do params( - spec: T.any( - { - const: T.nilable(T.any(NilClass, T::Boolean, Integer, Float, Symbol)), - enum: T.nilable(T.proc.returns(FinchAPI::Internal::Type::Converter::Input)), - union: T.nilable(T.proc.returns(FinchAPI::Internal::Type::Converter::Input)) - }, - T.proc.returns(FinchAPI::Internal::Type::Converter::Input), - FinchAPI::Internal::Type::Converter::Input - ) - ) - .returns(T.proc.returns(T.anything)) + spec: + T.any( + { + const: + T.nilable( + T.any(NilClass, T::Boolean, Integer, Float, Symbol) + ), + enum: + T.nilable( + T.proc.returns( + FinchAPI::Internal::Type::Converter::Input + ) + ), + union: + T.nilable( + T.proc.returns( + FinchAPI::Internal::Type::Converter::Input + ) + ) + }, + T.proc.returns(FinchAPI::Internal::Type::Converter::Input), + FinchAPI::Internal::Type::Converter::Input + ) + ).returns(T.proc.returns(T.anything)) + end + def self.type_info(spec) end - def self.type_info(spec); end # @api private # @@ -72,8 +102,7 @@ module FinchAPI target: FinchAPI::Internal::Type::Converter::Input, value: T.anything, state: FinchAPI::Internal::Type::Converter::CoerceState - ) - .returns(T.anything) + ).returns(T.anything) end def self.coerce( target, @@ -97,22 +126,33 @@ module FinchAPI # - `no`: the value cannot be converted to the target type. # # See implementation below for more details. - state: {strictness: true, exactness: {yes: 0, no: 0, maybe: 0}, branched: 0} - ); end + state: { + strictness: true, + exactness: { + yes: 0, + no: 0, + maybe: 0 + }, + branched: 0 + } + ) + end + # @api private sig do params( target: FinchAPI::Internal::Type::Converter::Input, value: T.anything, state: FinchAPI::Internal::Type::Converter::DumpState - ) - .returns(T.anything) + ).returns(T.anything) + end + def self.dump(target, value, state: { can_retry: true }) end - def self.dump(target, value, state: {can_retry: true}); end # @api private sig { params(target: T.anything, depth: Integer).returns(String) } - def self.inspect(target, depth:); end + def self.inspect(target, depth:) + end end end end diff --git a/rbi/finch_api/internal/type/enum.rbi b/rbi/finch_api/internal/type/enum.rbi index ecc84141..9ce15417 100644 --- a/rbi/finch_api/internal/type/enum.rbi +++ b/rbi/finch_api/internal/type/enum.rbi @@ -19,17 +19,25 @@ module FinchAPI include FinchAPI::Internal::Type::Converter # 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 + sig do + overridable.returns( + T::Array[T.any(NilClass, T::Boolean, Integer, Float, Symbol)] + ) + end + def values + end sig { params(other: T.anything).returns(T::Boolean) } - def ===(other); end + def ===(other) + end sig { params(other: T.anything).returns(T::Boolean) } - def ==(other); end + def ==(other) + end sig { returns(Integer) } - def hash; end + def hash + end # @api private # @@ -37,27 +45,31 @@ module FinchAPI # of the enum. sig do override - .params(value: T.any( - String, - Symbol, - T.anything - ), - state: FinchAPI::Internal::Type::Converter::CoerceState) + .params( + value: T.any(String, Symbol, T.anything), + state: FinchAPI::Internal::Type::Converter::CoerceState + ) .returns(T.any(Symbol, T.anything)) end - def coerce(value, state:); end + def coerce(value, state:) + end # @api private sig do override - .params(value: T.any(Symbol, T.anything), state: FinchAPI::Internal::Type::Converter::DumpState) + .params( + value: T.any(Symbol, T.anything), + state: FinchAPI::Internal::Type::Converter::DumpState + ) .returns(T.any(Symbol, T.anything)) end - def dump(value, state:); end + def dump(value, state:) + end # @api private sig { params(depth: Integer).returns(String) } - def inspect(depth: 0); end + def inspect(depth: 0) + end end end end diff --git a/rbi/finch_api/internal/type/file_input.rbi b/rbi/finch_api/internal/type/file_input.rbi index f2cafc93..ae0244c4 100644 --- a/rbi/finch_api/internal/type/file_input.rbi +++ b/rbi/finch_api/internal/type/file_input.rbi @@ -16,10 +16,12 @@ module FinchAPI abstract! sig { params(other: T.anything).returns(T::Boolean) } - def self.===(other); end + def self.===(other) + end sig { params(other: T.anything).returns(T::Boolean) } - def self.==(other); end + def self.==(other) + end class << self # @api private @@ -31,7 +33,8 @@ module FinchAPI ) .returns(T.any(StringIO, T.anything)) end - def coerce(value, state:); end + def coerce(value, state:) + end # @api private sig do @@ -42,7 +45,8 @@ module FinchAPI ) .returns(T.any(Pathname, StringIO, IO, String, T.anything)) end - def dump(value, state:); end + def dump(value, state:) + end end end end diff --git a/rbi/finch_api/internal/type/hash_of.rbi b/rbi/finch_api/internal/type/hash_of.rbi index 8fb3c136..e9cf964b 100644 --- a/rbi/finch_api/internal/type/hash_of.rbi +++ b/rbi/finch_api/internal/type/hash_of.rbi @@ -15,25 +15,29 @@ module FinchAPI sig do params( - type_info: T.any( - FinchAPI::Internal::AnyHash, - T.proc.returns(FinchAPI::Internal::Type::Converter::Input), - FinchAPI::Internal::Type::Converter::Input - ), + type_info: + T.any( + FinchAPI::Internal::AnyHash, + T.proc.returns(FinchAPI::Internal::Type::Converter::Input), + FinchAPI::Internal::Type::Converter::Input + ), spec: FinchAPI::Internal::AnyHash - ) - .returns(T.attached_class) + ).returns(T.attached_class) + end + def self.[](type_info, spec = {}) end - def self.[](type_info, spec = {}); end sig { params(other: T.anything).returns(T::Boolean) } - def ===(other); end + def ===(other) + end sig { params(other: T.anything).returns(T::Boolean) } - def ==(other); end + def ==(other) + end sig { returns(Integer) } - def hash; end + def hash + end # @api private sig do @@ -44,7 +48,8 @@ module FinchAPI ) .returns(T.any(FinchAPI::Internal::AnyHash, T.anything)) end - def coerce(value, state:); end + def coerce(value, state:) + end # @api private sig do @@ -55,33 +60,38 @@ module FinchAPI ) .returns(T.any(FinchAPI::Internal::AnyHash, T.anything)) end - def dump(value, state:); end + def dump(value, state:) + end # @api private sig { returns(Elem) } - protected def item_type; end + protected def item_type + end # @api private sig { returns(T::Boolean) } - protected def nilable?; end + protected def nilable? + end # @api private sig do params( - type_info: T.any( - FinchAPI::Internal::AnyHash, - T.proc.returns(FinchAPI::Internal::Type::Converter::Input), - FinchAPI::Internal::Type::Converter::Input - ), + type_info: + T.any( + FinchAPI::Internal::AnyHash, + T.proc.returns(FinchAPI::Internal::Type::Converter::Input), + FinchAPI::Internal::Type::Converter::Input + ), spec: FinchAPI::Internal::AnyHash - ) - .void + ).void + end + def initialize(type_info, spec = {}) end - def initialize(type_info, spec = {}); end # @api private sig { params(depth: Integer).returns(String) } - def inspect(depth: 0); end + def inspect(depth: 0) + end end end end diff --git a/rbi/finch_api/internal/type/request_parameters.rbi b/rbi/finch_api/internal/type/request_parameters.rbi index 31f1b420..62a08872 100644 --- a/rbi/finch_api/internal/type/request_parameters.rbi +++ b/rbi/finch_api/internal/type/request_parameters.rbi @@ -6,14 +6,22 @@ module FinchAPI # @api private module RequestParameters # Options to specify HTTP behaviour for this request. - sig { returns(FinchAPI::RequestOpts) } - attr_accessor :request_options + sig { returns(FinchAPI::RequestOptions) } + attr_reader :request_options + + sig { params(request_options: FinchAPI::RequestOptions::OrHash).void } + attr_writer :request_options # @api private module Converter # @api private - sig { params(params: T.anything).returns([T.anything, FinchAPI::Internal::AnyHash]) } - def dump_request(params); end + sig do + params(params: T.anything).returns( + [T.anything, FinchAPI::Internal::AnyHash] + ) + end + def dump_request(params) + end end end end diff --git a/rbi/finch_api/internal/type/union.rbi b/rbi/finch_api/internal/type/union.rbi index 20511c1d..c2ceea53 100644 --- a/rbi/finch_api/internal/type/union.rbi +++ b/rbi/finch_api/internal/type/union.rbi @@ -11,64 +11,99 @@ module FinchAPI # # All of the specified variant info for this union. sig do - returns(T::Array[[T.nilable(Symbol), T.proc.returns(FinchAPI::Internal::Type::Converter::Input)]]) + returns( + T::Array[ + [ + T.nilable(Symbol), + T.proc.returns(FinchAPI::Internal::Type::Converter::Input) + ] + ] + ) + end + private def known_variants end - private def known_variants; end # @api private sig { returns(T::Array[[T.nilable(Symbol), T.anything]]) } - protected def derefed_variants; end + protected def derefed_variants + end # All of the specified variants for this union. sig { overridable.returns(T::Array[T.anything]) } - def variants; end + def variants + end # @api private sig { params(property: Symbol).void } - private def discriminator(property); end + private def discriminator(property) + end # @api private sig do params( - key: T.any(Symbol, FinchAPI::Internal::AnyHash, T.proc.returns(T.anything), T.anything), - spec: T.any(FinchAPI::Internal::AnyHash, T.proc.returns(T.anything), T.anything) - ) - .void + key: + T.any( + Symbol, + FinchAPI::Internal::AnyHash, + T.proc.returns(T.anything), + T.anything + ), + spec: + T.any( + FinchAPI::Internal::AnyHash, + T.proc.returns(T.anything), + T.anything + ) + ).void + end + private def variant(key, spec = nil) end - private def variant(key, spec = nil); end # @api private sig { params(value: T.anything).returns(T.nilable(T.anything)) } - private def resolve_variant(value); end + private def resolve_variant(value) + end sig { params(other: T.anything).returns(T::Boolean) } - def ===(other); end + def ===(other) + end sig { params(other: T.anything).returns(T::Boolean) } - def ==(other); end + def ==(other) + end sig { returns(Integer) } - def hash; end + def hash + end # @api private sig do override - .params(value: T.anything, state: FinchAPI::Internal::Type::Converter::CoerceState) + .params( + value: T.anything, + state: FinchAPI::Internal::Type::Converter::CoerceState + ) .returns(T.anything) end - def coerce(value, state:); end + def coerce(value, state:) + end # @api private sig do override - .params(value: T.anything, state: FinchAPI::Internal::Type::Converter::DumpState) + .params( + value: T.anything, + state: FinchAPI::Internal::Type::Converter::DumpState + ) .returns(T.anything) end - def dump(value, state:); end + def dump(value, state:) + end # @api private sig { params(depth: Integer).returns(String) } - def inspect(depth: 0); end + def inspect(depth: 0) + end end end end diff --git a/rbi/finch_api/internal/type/unknown.rbi b/rbi/finch_api/internal/type/unknown.rbi index b83ec62d..8c971492 100644 --- a/rbi/finch_api/internal/type/unknown.rbi +++ b/rbi/finch_api/internal/type/unknown.rbi @@ -12,27 +12,37 @@ module FinchAPI abstract! sig { params(other: T.anything).returns(T::Boolean) } - def self.===(other); end + def self.===(other) + end sig { params(other: T.anything).returns(T::Boolean) } - def self.==(other); end + def self.==(other) + end class << self # @api private sig do override - .params(value: T.anything, state: FinchAPI::Internal::Type::Converter::CoerceState) + .params( + value: T.anything, + state: FinchAPI::Internal::Type::Converter::CoerceState + ) .returns(T.anything) end - def coerce(value, state:); end + def coerce(value, state:) + end # @api private sig do override - .params(value: T.anything, state: FinchAPI::Internal::Type::Converter::DumpState) + .params( + value: T.anything, + state: FinchAPI::Internal::Type::Converter::DumpState + ) .returns(T.anything) end - def dump(value, state:); end + def dump(value, state:) + end end end end diff --git a/rbi/finch_api/internal/util.rbi b/rbi/finch_api/internal/util.rbi index ce58cf64..3d68dc8d 100644 --- a/rbi/finch_api/internal/util.rbi +++ b/rbi/finch_api/internal/util.rbi @@ -6,56 +6,102 @@ module FinchAPI module Util # @api private sig { returns(Float) } - def self.monotonic_secs; end + def self.monotonic_secs + end class << self # @api private sig { returns(String) } - def arch; end + def arch + end # @api private sig { returns(String) } - def os; end + def os + end end class << self # @api private sig { params(input: T.anything).returns(T::Boolean) } - def primitive?(input); end + def primitive?(input) + end # @api private - sig { params(input: T.any(String, T::Boolean)).returns(T.any(T::Boolean, T.anything)) } - def coerce_boolean(input); end + sig do + params(input: T.any(String, T::Boolean)).returns( + T.any(T::Boolean, T.anything) + ) + end + def coerce_boolean(input) + end # @api private - sig { params(input: T.any(String, T::Boolean)).returns(T.nilable(T::Boolean)) } - def coerce_boolean!(input); end + sig do + params(input: T.any(String, T::Boolean)).returns( + T.nilable(T::Boolean) + ) + end + def coerce_boolean!(input) + end # @api private - sig { params(input: T.any(String, Integer)).returns(T.any(Integer, T.anything)) } - def coerce_integer(input); end + sig do + params(input: T.any(String, Integer)).returns( + T.any(Integer, T.anything) + ) + end + def coerce_integer(input) + end # @api private - sig { params(input: T.any(String, Integer, Float)).returns(T.any(Float, T.anything)) } - def coerce_float(input); end + sig do + params(input: T.any(String, Integer, Float)).returns( + T.any(Float, T.anything) + ) + end + 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 + sig do + params(input: T.anything).returns( + T.any(T::Hash[T.anything, T.anything], T.anything) + ) + end + def coerce_hash(input) + end + + # @api private + sig do + params(input: T.anything).returns( + T.nilable(T::Hash[T.anything, T.anything]) + ) + end + def coerce_hash!(input) + end end 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 + sig do + params(lhs: T.anything, rhs: T.anything, concat: T::Boolean).returns( + T.anything + ) + end + 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) + params( + values: T::Array[T.anything], + sentinel: T.nilable(T.anything), + concat: T::Boolean + ).returns(T.anything) end def deep_merge( *values, @@ -63,47 +109,67 @@ module FinchAPI sentinel: nil, # whether to merge sequences by concatenation. concat: false - ); end + ) + end + # @api private sig do params( - data: T.any(FinchAPI::Internal::AnyHash, T::Array[T.anything], T.anything), - pick: T.nilable( + data: T.any( - Symbol, - Integer, - T::Array[T.any(Symbol, Integer)], - T.proc.params(arg0: T.anything).returns(T.anything) - ) - ), + FinchAPI::Internal::AnyHash, + T::Array[T.anything], + T.anything + ), + pick: + T.nilable( + T.any( + Symbol, + Integer, + T::Array[T.any(Symbol, Integer)], + T.proc.params(arg0: T.anything).returns(T.anything) + ) + ), blk: T.nilable(T.proc.returns(T.anything)) - ) - .returns(T.nilable(T.anything)) + ).returns(T.nilable(T.anything)) + end + def dig(data, pick, &blk) end - def dig(data, pick, &blk); end end class << self # @api private sig { params(uri: URI::Generic).returns(String) } - def uri_origin(uri); end + def uri_origin(uri) + end # @api private sig { params(path: T.any(String, T::Array[String])).returns(String) } - def interpolate_path(path); end + 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 + sig do + params(query: T.nilable(String)).returns( + T::Hash[String, T::Array[String]] + ) + end + 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)) + 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 - def encode_query(query); end end ParsedUriShape = @@ -119,31 +185,53 @@ module FinchAPI class << self # @api private - sig { params(url: T.any(URI::Generic, String)).returns(FinchAPI::Internal::Util::ParsedUriShape) } - def parse_uri(url); end + sig do + params(url: T.any(URI::Generic, String)).returns( + FinchAPI::Internal::Util::ParsedUriShape + ) + end + def parse_uri(url) + end # @api private - sig { params(parsed: FinchAPI::Internal::Util::ParsedUriShape).returns(URI::Generic) } - def unparse_uri(parsed); end + sig do + params(parsed: FinchAPI::Internal::Util::ParsedUriShape).returns( + URI::Generic + ) + end + def unparse_uri(parsed) + end # @api private sig do - params(lhs: FinchAPI::Internal::Util::ParsedUriShape, rhs: FinchAPI::Internal::Util::ParsedUriShape) - .returns(URI::Generic) + params( + lhs: FinchAPI::Internal::Util::ParsedUriShape, + rhs: FinchAPI::Internal::Util::ParsedUriShape + ).returns(URI::Generic) + end + def join_parsed_uri(lhs, rhs) end - def join_parsed_uri(lhs, rhs); end end class << self # @api private 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]) + 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 - def normalized_headers(*headers); end end # @api private @@ -152,38 +240,54 @@ module FinchAPI class ReadIOAdapter # @api private sig { returns(T.nilable(T::Boolean)) } - def close?; end + def close? + end # @api private sig { void } - def close; end + def close + end # @api private sig { params(max_len: T.nilable(Integer)).returns(String) } - private def read_enum(max_len); end + 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 + sig do + params( + max_len: T.nilable(Integer), + out_string: T.nilable(String) + ).returns(T.nilable(String)) + end + def read(max_len = nil, out_string = nil) + end # @api private sig do params( src: T.any(String, Pathname, StringIO, T::Enumerable[String]), blk: T.proc.params(arg0: String).void - ) - .returns(T.attached_class) + ).returns(T.attached_class) + end + def self.new(src, &blk) end - def self.new(src, &blk); end end class << self - sig { params(blk: T.proc.params(y: Enumerator::Yielder).void).returns(T::Enumerable[String]) } - def writable_enum(&blk); end + sig do + params(blk: T.proc.params(y: Enumerator::Yielder).void).returns( + T::Enumerable[String] + ) + end + def writable_enum(&blk) + end end - JSON_CONTENT = T.let(%r{^application/(?:vnd(?:\.[^.]+)*\+)?json(?!l)}, Regexp) - JSONL_CONTENT = T.let(%r{^application/(?:x-)?jsonl}, Regexp) + JSON_CONTENT = + T.let(%r{^application/(?:vnd(?:\.[^.]+)*\+)?json(?!l)}, Regexp) + JSONL_CONTENT = + T.let(%r{^application/(:?x-(?:n|l)djson)|(:?(?:x-)?jsonl)}, Regexp) class << self # @api private @@ -193,10 +297,15 @@ module FinchAPI val: T.anything, closing: T::Array[T.proc.void], content_type: T.nilable(String) - ) - .void + ).void + end + private def write_multipart_content( + y, + val:, + closing:, + content_type: nil + ) end - private def write_multipart_content(y, val:, closing:, content_type: nil); end # @api private sig do @@ -206,24 +315,33 @@ module FinchAPI key: T.any(Symbol, String), val: T.anything, closing: T::Array[T.proc.void] - ) - .void + ).void + end + private def write_multipart_chunk(y, boundary:, key:, val:, closing:) end - private def write_multipart_chunk(y, boundary:, key:, val:, closing:); end # @api private - sig { params(body: T.anything).returns([String, T::Enumerable[String]]) } - private def encode_multipart_streaming(body); end + sig do + params(body: T.anything).returns([String, T::Enumerable[String]]) + end + 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 + sig do + params(headers: T::Hash[String, String], body: T.anything).returns( + T.anything + ) + end + def encode_content(headers, body) + end # @api private # # https://www.iana.org/assignments/character-sets/character-sets.xhtml sig { params(content_type: String, text: String).void } - def force_charset!(content_type, text:); end + def force_charset!(content_type, text:) + end # @api private # @@ -233,10 +351,10 @@ module FinchAPI headers: T.any(T::Hash[String, String], Net::HTTPHeader), stream: T::Enumerable[String], suppress_error: T::Boolean - ) - .returns(T.anything) + ).returns(T.anything) + end + def decode_content(headers, stream:, suppress_error: false) end - def decode_content(headers, stream:, suppress_error: false); end end class << self @@ -244,24 +362,29 @@ module FinchAPI # # 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]) + 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 - 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 + def close_fused!(enum) + end # @api private sig do params( enum: T.nilable(T::Enumerable[T.anything]), blk: T.proc.params(arg0: Enumerator::Yielder).void - ) - .returns(T::Enumerable[T.anything]) + ).returns(T::Enumerable[T.anything]) + end + def chain_fused(enum, &blk) end - def chain_fused(enum, &blk); end end ServerSentEvent = @@ -281,8 +404,11 @@ module FinchAPI # # This decoder is responsible for reassembling lines split across multiple # fragments. - sig { params(enum: T::Enumerable[String]).returns(T::Enumerable[String]) } - def decode_lines(enum); end + sig do + params(enum: T::Enumerable[String]).returns(T::Enumerable[String]) + end + def decode_lines(enum) + end # @api private # @@ -290,9 +416,12 @@ module FinchAPI # # Assumes that `lines` has been decoded with `#decode_lines`. sig do - params(lines: T::Enumerable[String]).returns(T::Enumerable[FinchAPI::Internal::Util::ServerSentEvent]) + params(lines: T::Enumerable[String]).returns( + T::Enumerable[FinchAPI::Internal::Util::ServerSentEvent] + ) + end + def decode_sse(lines) end - def decode_sse(lines); end end end end diff --git a/rbi/finch_api/models.rbi b/rbi/finch_api/models.rbi new file mode 100644 index 00000000..85762ce5 --- /dev/null +++ b/rbi/finch_api/models.rbi @@ -0,0 +1,66 @@ +# typed: strong + +module FinchAPI + AccessTokenCreateParams = FinchAPI::Models::AccessTokenCreateParams + + AccountDisconnectParams = FinchAPI::Models::AccountDisconnectParams + + AccountIntrospectParams = FinchAPI::Models::AccountIntrospectParams + + AccountUpdateEvent = FinchAPI::Models::AccountUpdateEvent + + BaseWebhookEvent = FinchAPI::Models::BaseWebhookEvent + + CompanyEvent = FinchAPI::Models::CompanyEvent + + Connect = FinchAPI::Models::Connect + + ConnectionStatusType = FinchAPI::Models::ConnectionStatusType + + CreateAccessTokenResponse = FinchAPI::Models::CreateAccessTokenResponse + + DirectoryEvent = FinchAPI::Models::DirectoryEvent + + DisconnectResponse = FinchAPI::Models::DisconnectResponse + + EmploymentEvent = FinchAPI::Models::EmploymentEvent + + HRIS = FinchAPI::Models::HRIS + + Income = FinchAPI::Models::Income + + IndividualEvent = FinchAPI::Models::IndividualEvent + + Introspection = FinchAPI::Models::Introspection + + JobCompletionEvent = FinchAPI::Models::JobCompletionEvent + + Jobs = FinchAPI::Models::Jobs + + Location = FinchAPI::Models::Location + + Money = FinchAPI::Models::Money + + OperationSupport = FinchAPI::Models::OperationSupport + + OperationSupportMatrix = FinchAPI::Models::OperationSupportMatrix + + Paging = FinchAPI::Models::Paging + + PaymentEvent = FinchAPI::Models::PaymentEvent + + Payroll = FinchAPI::Models::Payroll + + PayStatementEvent = FinchAPI::Models::PayStatementEvent + + Provider = FinchAPI::Models::Provider + + ProviderListParams = FinchAPI::Models::ProviderListParams + + RequestForwardingForwardParams = + FinchAPI::Models::RequestForwardingForwardParams + + Sandbox = FinchAPI::Models::Sandbox + + WebhookEvent = FinchAPI::Models::WebhookEvent +end diff --git a/rbi/finch_api/models/access_token_create_params.rbi b/rbi/finch_api/models/access_token_create_params.rbi index d4df2a27..d2344ecd 100644 --- a/rbi/finch_api/models/access_token_create_params.rbi +++ b/rbi/finch_api/models/access_token_create_params.rbi @@ -6,6 +6,8 @@ module FinchAPI extend FinchAPI::Internal::Type::RequestParameters::Converter include FinchAPI::Internal::Type::RequestParameters + OrHash = T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + sig { returns(String) } attr_accessor :code @@ -33,25 +35,31 @@ module FinchAPI client_id: String, client_secret: String, redirect_uri: String, - request_options: T.any(FinchAPI::RequestOptions, FinchAPI::Internal::AnyHash) - ) - .returns(T.attached_class) + request_options: FinchAPI::RequestOptions::OrHash + ).returns(T.attached_class) + end + def self.new( + code:, + client_id: nil, + client_secret: nil, + redirect_uri: nil, + request_options: {} + ) end - def self.new(code:, client_id: nil, client_secret: nil, redirect_uri: nil, request_options: {}); end sig do - override - .returns( - { - code: String, - client_id: String, - client_secret: String, - redirect_uri: String, - request_options: FinchAPI::RequestOptions - } - ) + override.returns( + { + code: String, + client_id: String, + client_secret: String, + redirect_uri: String, + request_options: FinchAPI::RequestOptions + } + ) + end + def to_hash end - def to_hash; end end end end diff --git a/rbi/finch_api/models/account_disconnect_params.rbi b/rbi/finch_api/models/account_disconnect_params.rbi index 028ce2fe..66b06e9c 100644 --- a/rbi/finch_api/models/account_disconnect_params.rbi +++ b/rbi/finch_api/models/account_disconnect_params.rbi @@ -6,14 +6,19 @@ module FinchAPI extend FinchAPI::Internal::Type::RequestParameters::Converter include FinchAPI::Internal::Type::RequestParameters + OrHash = T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + sig do - params(request_options: T.any(FinchAPI::RequestOptions, FinchAPI::Internal::AnyHash)) - .returns(T.attached_class) + params(request_options: FinchAPI::RequestOptions::OrHash).returns( + T.attached_class + ) + end + def self.new(request_options: {}) end - def self.new(request_options: {}); end - sig { override.returns({request_options: FinchAPI::RequestOptions}) } - def to_hash; end + sig { override.returns({ request_options: FinchAPI::RequestOptions }) } + def to_hash + end end end end diff --git a/rbi/finch_api/models/account_introspect_params.rbi b/rbi/finch_api/models/account_introspect_params.rbi index 4ee05f4c..0c59ae46 100644 --- a/rbi/finch_api/models/account_introspect_params.rbi +++ b/rbi/finch_api/models/account_introspect_params.rbi @@ -6,14 +6,19 @@ module FinchAPI extend FinchAPI::Internal::Type::RequestParameters::Converter include FinchAPI::Internal::Type::RequestParameters + OrHash = T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + sig do - params(request_options: T.any(FinchAPI::RequestOptions, FinchAPI::Internal::AnyHash)) - .returns(T.attached_class) + params(request_options: FinchAPI::RequestOptions::OrHash).returns( + T.attached_class + ) + end + def self.new(request_options: {}) end - def self.new(request_options: {}); end - sig { override.returns({request_options: FinchAPI::RequestOptions}) } - def to_hash; end + sig { override.returns({ request_options: FinchAPI::RequestOptions }) } + def to_hash + end end end end diff --git a/rbi/finch_api/models/account_update_event.rbi b/rbi/finch_api/models/account_update_event.rbi index 97337d63..27d230e3 100644 --- a/rbi/finch_api/models/account_update_event.rbi +++ b/rbi/finch_api/models/account_update_event.rbi @@ -3,123 +3,156 @@ module FinchAPI module Models class AccountUpdateEvent < FinchAPI::Models::BaseWebhookEvent - sig { returns(T.nilable(FinchAPI::Models::AccountUpdateEvent::Data)) } + OrHash = T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + + sig { returns(T.nilable(FinchAPI::AccountUpdateEvent::Data)) } attr_reader :data - sig { params(data: T.any(FinchAPI::Models::AccountUpdateEvent::Data, FinchAPI::Internal::AnyHash)).void } + sig { params(data: FinchAPI::AccountUpdateEvent::Data::OrHash).void } attr_writer :data - sig { returns(T.nilable(FinchAPI::Models::AccountUpdateEvent::EventType::TaggedSymbol)) } + sig do + returns( + T.nilable(FinchAPI::AccountUpdateEvent::EventType::TaggedSymbol) + ) + end attr_reader :event_type - sig { params(event_type: FinchAPI::Models::AccountUpdateEvent::EventType::OrSymbol).void } + sig do + params( + event_type: FinchAPI::AccountUpdateEvent::EventType::OrSymbol + ).void + end attr_writer :event_type sig do params( - data: T.any(FinchAPI::Models::AccountUpdateEvent::Data, FinchAPI::Internal::AnyHash), - event_type: FinchAPI::Models::AccountUpdateEvent::EventType::OrSymbol - ) - .returns(T.attached_class) + data: FinchAPI::AccountUpdateEvent::Data::OrHash, + event_type: FinchAPI::AccountUpdateEvent::EventType::OrSymbol + ).returns(T.attached_class) + end + def self.new(data: nil, event_type: nil) end - def self.new(data: nil, event_type: nil); end sig do - override - .returns( - { - data: FinchAPI::Models::AccountUpdateEvent::Data, - event_type: FinchAPI::Models::AccountUpdateEvent::EventType::TaggedSymbol - } - ) + override.returns( + { + data: FinchAPI::AccountUpdateEvent::Data, + event_type: FinchAPI::AccountUpdateEvent::EventType::TaggedSymbol + } + ) + end + def to_hash end - def to_hash; end class Data < FinchAPI::Internal::Type::BaseModel - sig { returns(FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod) } + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + + sig do + returns(FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod) + end attr_reader :authentication_method sig do params( - authentication_method: T.any(FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod, FinchAPI::Internal::AnyHash) - ) - .void + authentication_method: + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::OrHash + ).void end attr_writer :authentication_method - sig { returns(FinchAPI::Models::ConnectionStatusType::TaggedSymbol) } + sig { returns(FinchAPI::ConnectionStatusType::TaggedSymbol) } attr_accessor :status sig do params( - authentication_method: T.any(FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod, FinchAPI::Internal::AnyHash), - status: FinchAPI::Models::ConnectionStatusType::OrSymbol - ) - .returns(T.attached_class) + authentication_method: + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::OrHash, + status: FinchAPI::ConnectionStatusType::OrSymbol + ).returns(T.attached_class) + end + def self.new(authentication_method:, status:) end - def self.new(authentication_method:, status:); end sig do - override - .returns( - { - authentication_method: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod, - status: FinchAPI::Models::ConnectionStatusType::TaggedSymbol - } - ) + override.returns( + { + authentication_method: + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod, + status: FinchAPI::ConnectionStatusType::TaggedSymbol + } + ) + end + def to_hash end - def to_hash; end class AuthenticationMethod < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + # 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)) } + sig { returns(T.nilable(FinchAPI::HRIS::BenefitsSupport)) } attr_reader :benefits_support sig do params( - benefits_support: T.nilable(T.any(FinchAPI::Models::HRIS::BenefitsSupport, FinchAPI::Internal::AnyHash)) - ) - .void + benefits_support: + T.nilable(FinchAPI::HRIS::BenefitsSupport::OrHash) + ).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)) } + sig do + returns( + T.nilable( + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields + ) + ) + end attr_reader :supported_fields sig do params( - supported_fields: T.nilable( - T.any( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields, - FinchAPI::Internal::AnyHash + supported_fields: + T.nilable( + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::OrHash ) - ) - ) - .void + ).void end attr_writer :supported_fields # The type of authentication method. - sig { returns(T.nilable(FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::Type::TaggedSymbol)) } + sig do + returns( + T.nilable( + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::Type::TaggedSymbol + ) + ) + end attr_reader :type - sig { params(type: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::Type::OrSymbol).void } + sig do + params( + type: + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::Type::OrSymbol + ).void + end attr_writer :type sig do params( - benefits_support: T.nilable(T.any(FinchAPI::Models::HRIS::BenefitsSupport, FinchAPI::Internal::AnyHash)), - supported_fields: T.nilable( - T.any( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields, - FinchAPI::Internal::AnyHash - ) - ), - type: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::Type::OrSymbol - ) - .returns(T.attached_class) + benefits_support: + T.nilable(FinchAPI::HRIS::BenefitsSupport::OrHash), + supported_fields: + T.nilable( + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::OrHash + ), + type: + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::Type::OrSymbol + ).returns(T.attached_class) end def self.new( # Each benefit type and their supported features. If the benefit type is not @@ -129,179 +162,166 @@ module FinchAPI supported_fields: nil, # The type of authentication method. type: nil - ); end + ) + end + sig do - override - .returns( - { - benefits_support: T.nilable(FinchAPI::Models::HRIS::BenefitsSupport), - supported_fields: T.nilable(FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields), - type: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::Type::TaggedSymbol - } - ) + override.returns( + { + benefits_support: T.nilable(FinchAPI::HRIS::BenefitsSupport), + supported_fields: + T.nilable( + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields + ), + type: + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::Type::TaggedSymbol + } + ) + end + def to_hash end - def to_hash; end class SupportedFields < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + sig do returns( - T.nilable(FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company) + T.nilable( + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company + ) ) end attr_reader :company sig do params( - company: T.any( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company, - FinchAPI::Internal::AnyHash - ) - ) - .void + company: + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::OrHash + ).void end attr_writer :company sig do returns( - T.nilable(FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory) + T.nilable( + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory + ) ) end attr_reader :directory sig do params( - directory: T.any( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory, - FinchAPI::Internal::AnyHash - ) - ) - .void + directory: + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory::OrHash + ).void end attr_writer :directory sig do returns( - T.nilable(FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment) + T.nilable( + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment + ) ) end attr_reader :employment sig do params( - employment: T.any( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment, - FinchAPI::Internal::AnyHash - ) - ) - .void + employment: + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::OrHash + ).void end attr_writer :employment sig do returns( - T.nilable(FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual) + T.nilable( + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual + ) ) end attr_reader :individual sig do params( - individual: T.any( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual, - FinchAPI::Internal::AnyHash - ) - ) - .void + individual: + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual::OrHash + ).void end attr_writer :individual sig do returns( - T.nilable(FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayGroup) + T.nilable( + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayGroup + ) ) end attr_reader :pay_group sig do params( - pay_group: T.any( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayGroup, - FinchAPI::Internal::AnyHash - ) - ) - .void + pay_group: + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayGroup::OrHash + ).void end attr_writer :pay_group sig do returns( - T.nilable(FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement) + T.nilable( + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement + ) ) end attr_reader :pay_statement sig do params( - pay_statement: T.any( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement, - FinchAPI::Internal::AnyHash - ) - ) - .void + pay_statement: + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::OrHash + ).void end attr_writer :pay_statement sig do returns( - T.nilable(FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Payment) + T.nilable( + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Payment + ) ) end attr_reader :payment sig do params( - payment: T.any( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Payment, - FinchAPI::Internal::AnyHash - ) - ) - .void + payment: + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Payment::OrHash + ).void end attr_writer :payment # The supported data fields returned by our HR and payroll endpoints sig do params( - company: T.any( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company, - FinchAPI::Internal::AnyHash - ), - directory: T.any( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory, - FinchAPI::Internal::AnyHash - ), - employment: T.any( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment, - FinchAPI::Internal::AnyHash - ), - individual: T.any( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual, - FinchAPI::Internal::AnyHash - ), - pay_group: T.any( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayGroup, - FinchAPI::Internal::AnyHash - ), - pay_statement: T.any( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement, - FinchAPI::Internal::AnyHash - ), - payment: T.any( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Payment, - FinchAPI::Internal::AnyHash - ) - ) - .returns(T.attached_class) + company: + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::OrHash, + directory: + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory::OrHash, + employment: + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::OrHash, + individual: + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual::OrHash, + pay_group: + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayGroup::OrHash, + pay_statement: + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::OrHash, + payment: + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Payment::OrHash + ).returns(T.attached_class) end def self.new( company: nil, @@ -311,24 +331,36 @@ module FinchAPI pay_group: nil, pay_statement: nil, payment: nil - ); end + ) + end + sig do - override - .returns( - { - 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 - } - ) + override.returns( + { + company: + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company, + directory: + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory, + employment: + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment, + individual: + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual, + pay_group: + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayGroup, + pay_statement: + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement, + payment: + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Payment + } + ) + end + def to_hash end - def to_hash; end class Company < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + sig { returns(T.nilable(T::Boolean)) } attr_reader :id @@ -338,7 +370,7 @@ module FinchAPI sig do returns( T.nilable( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Accounts + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Accounts ) ) end @@ -346,19 +378,16 @@ module FinchAPI sig do params( - accounts: T.any( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Accounts, - FinchAPI::Internal::AnyHash - ) - ) - .void + accounts: + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Accounts::OrHash + ).void end attr_writer :accounts sig do returns( T.nilable( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Departments + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Departments ) ) end @@ -366,12 +395,9 @@ module FinchAPI sig do params( - departments: T.any( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Departments, - FinchAPI::Internal::AnyHash - ) - ) - .void + departments: + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Departments::OrHash + ).void end attr_writer :departments @@ -384,7 +410,7 @@ module FinchAPI sig do returns( T.nilable( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Entity + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Entity ) ) end @@ -392,12 +418,9 @@ module FinchAPI sig do params( - entity: T.any( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Entity, - FinchAPI::Internal::AnyHash - ) - ) - .void + entity: + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Entity::OrHash + ).void end attr_writer :entity @@ -410,7 +433,7 @@ module FinchAPI sig do returns( T.nilable( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Locations + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Locations ) ) end @@ -418,12 +441,9 @@ module FinchAPI sig do params( - locations: T.any( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Locations, - FinchAPI::Internal::AnyHash - ) - ) - .void + locations: + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Locations::OrHash + ).void end attr_writer :locations @@ -442,28 +462,19 @@ module FinchAPI sig do params( id: T::Boolean, - accounts: T.any( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Accounts, - FinchAPI::Internal::AnyHash - ), - departments: T.any( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Departments, - FinchAPI::Internal::AnyHash - ), + accounts: + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Accounts::OrHash, + departments: + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Departments::OrHash, ein: T::Boolean, - entity: T.any( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Entity, - FinchAPI::Internal::AnyHash - ), + entity: + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Entity::OrHash, legal_name: T::Boolean, - locations: T.any( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Locations, - FinchAPI::Internal::AnyHash - ), + locations: + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Locations::OrHash, primary_email: T::Boolean, primary_phone_number: T::Boolean - ) - .returns(T.attached_class) + ).returns(T.attached_class) end def self.new( id: nil, @@ -475,26 +486,37 @@ module FinchAPI locations: nil, primary_email: nil, primary_phone_number: nil - ); end + ) + end + sig do - override - .returns( - { - id: T::Boolean, - accounts: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Accounts, - departments: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Departments, - ein: T::Boolean, - entity: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Entity, - legal_name: T::Boolean, - locations: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Locations, - primary_email: T::Boolean, - primary_phone_number: T::Boolean - } - ) + override.returns( + { + id: T::Boolean, + accounts: + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Accounts, + departments: + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Departments, + ein: T::Boolean, + entity: + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Entity, + legal_name: T::Boolean, + locations: + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Locations, + primary_email: T::Boolean, + primary_phone_number: T::Boolean + } + ) + end + def to_hash end - def to_hash; end class Accounts < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any(T.self_type, FinchAPI::Internal::AnyHash) + end + sig { returns(T.nilable(T::Boolean)) } attr_reader :account_name @@ -532,8 +554,7 @@ module FinchAPI account_type: T::Boolean, institution_name: T::Boolean, routing_number: T::Boolean - ) - .returns(T.attached_class) + ).returns(T.attached_class) end def self.new( account_name: nil, @@ -545,21 +566,26 @@ module FinchAPI end sig do - override - .returns( - { - account_name: T::Boolean, - account_number: T::Boolean, - account_type: T::Boolean, - institution_name: T::Boolean, - routing_number: T::Boolean - } - ) + override.returns( + { + account_name: T::Boolean, + account_number: T::Boolean, + account_type: T::Boolean, + institution_name: T::Boolean, + routing_number: T::Boolean + } + ) + end + def to_hash end - def to_hash; end end class Departments < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any(T.self_type, FinchAPI::Internal::AnyHash) + end + sig { returns(T.nilable(T::Boolean)) } attr_reader :name @@ -569,7 +595,7 @@ module FinchAPI sig do returns( T.nilable( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Departments::Parent + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Departments::Parent ) ) end @@ -577,39 +603,40 @@ module FinchAPI sig do params( - parent: T.any( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Departments::Parent, - FinchAPI::Internal::AnyHash - ) - ) - .void + parent: + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Departments::Parent::OrHash + ).void end attr_writer :parent sig do params( name: T::Boolean, - parent: T.any( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Departments::Parent, - FinchAPI::Internal::AnyHash - ) - ) - .returns(T.attached_class) + parent: + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Departments::Parent::OrHash + ).returns(T.attached_class) + end + def self.new(name: nil, parent: nil) end - def self.new(name: nil, parent: nil); end sig do - override - .returns( - { - name: T::Boolean, - parent: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Departments::Parent - } - ) + override.returns( + { + name: T::Boolean, + parent: + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Departments::Parent + } + ) + end + def to_hash end - def to_hash; end class Parent < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any(T.self_type, FinchAPI::Internal::AnyHash) + end + sig { returns(T.nilable(T::Boolean)) } attr_reader :name @@ -617,14 +644,21 @@ module FinchAPI attr_writer :name sig { params(name: T::Boolean).returns(T.attached_class) } - def self.new(name: nil); end + def self.new(name: nil) + end - sig { override.returns({name: T::Boolean}) } - def to_hash; end + sig { override.returns({ name: T::Boolean }) } + def to_hash + end end end class Entity < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any(T.self_type, FinchAPI::Internal::AnyHash) + end + sig { returns(T.nilable(T::Boolean)) } attr_reader :subtype @@ -637,14 +671,27 @@ module FinchAPI 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); end + sig do + params(subtype: T::Boolean, type: T::Boolean).returns( + T.attached_class + ) + end + def self.new(subtype: nil, type: nil) + end - sig { override.returns({subtype: T::Boolean, type: T::Boolean}) } - def to_hash; end + sig do + override.returns({ subtype: T::Boolean, type: T::Boolean }) + end + def to_hash + end end class Locations < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any(T.self_type, FinchAPI::Internal::AnyHash) + end + sig { returns(T.nilable(T::Boolean)) } attr_reader :city @@ -689,34 +736,43 @@ module FinchAPI line2: T::Boolean, postal_code: T::Boolean, state: T::Boolean - ) - .returns(T.attached_class) + ).returns(T.attached_class) end - def self.new(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 - override - .returns( - { - city: T::Boolean, - country: T::Boolean, - line1: T::Boolean, - line2: T::Boolean, - postal_code: T::Boolean, - state: T::Boolean - } - ) + override.returns( + { + city: T::Boolean, + country: T::Boolean, + line1: T::Boolean, + line2: T::Boolean, + postal_code: T::Boolean, + state: T::Boolean + } + ) + end + def to_hash end - def to_hash; end end end class Directory < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + sig do returns( T.nilable( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory::Individuals + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory::Individuals ) ) end @@ -724,19 +780,16 @@ module FinchAPI sig do params( - individuals: T.any( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory::Individuals, - FinchAPI::Internal::AnyHash - ) - ) - .void + individuals: + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory::Individuals::OrHash + ).void end attr_writer :individuals sig do returns( T.nilable( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory::Paging + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory::Paging ) ) end @@ -744,42 +797,42 @@ module FinchAPI sig do params( - paging: T.any( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory::Paging, - FinchAPI::Internal::AnyHash - ) - ) - .void + paging: + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory::Paging::OrHash + ).void end attr_writer :paging sig do params( - individuals: T.any( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory::Individuals, - FinchAPI::Internal::AnyHash - ), - paging: T.any( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory::Paging, - FinchAPI::Internal::AnyHash - ) - ) - .returns(T.attached_class) + individuals: + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory::Individuals::OrHash, + paging: + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory::Paging::OrHash + ).returns(T.attached_class) + end + def self.new(individuals: nil, paging: nil) end - def self.new(individuals: nil, paging: nil); end sig do - override - .returns( - { - individuals: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory::Individuals, - paging: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory::Paging - } - ) + override.returns( + { + individuals: + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory::Individuals, + paging: + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory::Paging + } + ) + end + def to_hash end - def to_hash; end class Individuals < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any(T.self_type, FinchAPI::Internal::AnyHash) + end + sig { returns(T.nilable(T::Boolean)) } attr_reader :id @@ -813,7 +866,7 @@ module FinchAPI sig do returns( T.nilable( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory::Individuals::Manager + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory::Individuals::Manager ) ) end @@ -821,12 +874,9 @@ module FinchAPI sig do params( - manager: T.any( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory::Individuals::Manager, - FinchAPI::Internal::AnyHash - ) - ) - .void + manager: + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory::Individuals::Manager::OrHash + ).void end attr_writer :manager @@ -843,13 +893,10 @@ module FinchAPI first_name: T::Boolean, is_active: T::Boolean, last_name: T::Boolean, - manager: T.any( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory::Individuals::Manager, - FinchAPI::Internal::AnyHash - ), + manager: + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory::Individuals::Manager::OrHash, middle_name: T::Boolean - ) - .returns(T.attached_class) + ).returns(T.attached_class) end def self.new( id: nil, @@ -863,22 +910,28 @@ module FinchAPI end sig do - override - .returns( - { - id: T::Boolean, - department: T::Boolean, - first_name: T::Boolean, - is_active: T::Boolean, - last_name: T::Boolean, - manager: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory::Individuals::Manager, - middle_name: T::Boolean - } - ) + override.returns( + { + id: T::Boolean, + department: T::Boolean, + first_name: T::Boolean, + is_active: T::Boolean, + last_name: T::Boolean, + manager: + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory::Individuals::Manager, + middle_name: T::Boolean + } + ) + end + def to_hash end - def to_hash; end class Manager < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any(T.self_type, FinchAPI::Internal::AnyHash) + end + sig { returns(T.nilable(T::Boolean)) } attr_reader :id @@ -886,14 +939,21 @@ module FinchAPI attr_writer :id sig { params(id: T::Boolean).returns(T.attached_class) } - def self.new(id: nil); end + def self.new(id: nil) + end - sig { override.returns({id: T::Boolean}) } - def to_hash; end + sig { override.returns({ id: T::Boolean }) } + def to_hash + end end end class Paging < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any(T.self_type, FinchAPI::Internal::AnyHash) + end + sig { returns(T.nilable(T::Boolean)) } attr_reader :count @@ -906,15 +966,26 @@ module FinchAPI 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); end + sig do + params(count: T::Boolean, offset: T::Boolean).returns( + T.attached_class + ) + end + def self.new(count: nil, offset: nil) + end - sig { override.returns({count: T::Boolean, offset: T::Boolean}) } - def to_hash; end + sig do + override.returns({ count: T::Boolean, offset: T::Boolean }) + end + def to_hash + end end end class Employment < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + sig { returns(T.nilable(T::Boolean)) } attr_reader :id @@ -936,7 +1007,7 @@ module FinchAPI sig do returns( T.nilable( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Department + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Department ) ) end @@ -944,19 +1015,16 @@ module FinchAPI sig do params( - department: T.any( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Department, - FinchAPI::Internal::AnyHash - ) - ) - .void + department: + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Department::OrHash + ).void end attr_writer :department sig do returns( T.nilable( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Employment + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Employment ) ) end @@ -964,12 +1032,9 @@ module FinchAPI sig do params( - employment: T.any( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Employment, - FinchAPI::Internal::AnyHash - ) - ) - .void + employment: + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Employment::OrHash + ).void end attr_writer :employment @@ -994,7 +1059,7 @@ module FinchAPI sig do returns( T.nilable( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Income + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Income ) ) end @@ -1002,12 +1067,9 @@ module FinchAPI sig do params( - income: T.any( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Income, - FinchAPI::Internal::AnyHash - ) - ) - .void + income: + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Income::OrHash + ).void end attr_writer :income @@ -1032,7 +1094,7 @@ module FinchAPI sig do returns( T.nilable( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Location + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Location ) ) end @@ -1040,19 +1102,16 @@ module FinchAPI sig do params( - location: T.any( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Location, - FinchAPI::Internal::AnyHash - ) - ) - .void + location: + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Location::OrHash + ).void end attr_writer :location sig do returns( T.nilable( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Manager + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Manager ) ) end @@ -1060,12 +1119,9 @@ module FinchAPI sig do params( - manager: T.any( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Manager, - FinchAPI::Internal::AnyHash - ) - ) - .void + manager: + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Manager::OrHash + ).void end attr_writer :manager @@ -1092,37 +1148,26 @@ module FinchAPI id: T::Boolean, class_code: T::Boolean, custom_fields: T::Boolean, - department: T.any( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Department, - FinchAPI::Internal::AnyHash - ), - employment: T.any( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Employment, - FinchAPI::Internal::AnyHash - ), + department: + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Department::OrHash, + employment: + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Employment::OrHash, employment_status: T::Boolean, end_date: T::Boolean, first_name: T::Boolean, - income: T.any( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Income, - FinchAPI::Internal::AnyHash - ), + income: + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Income::OrHash, income_history: T::Boolean, is_active: T::Boolean, last_name: T::Boolean, - location: T.any( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Location, - FinchAPI::Internal::AnyHash - ), - manager: T.any( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Manager, - FinchAPI::Internal::AnyHash - ), + location: + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Location::OrHash, + manager: + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Manager::OrHash, middle_name: T::Boolean, start_date: T::Boolean, title: T::Boolean - ) - .returns(T.attached_class) + ).returns(T.attached_class) end def self.new( id: nil, @@ -1142,34 +1187,46 @@ module FinchAPI middle_name: nil, start_date: nil, title: nil - ); end + ) + end + sig do - override - .returns( - { - 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, - employment_status: T::Boolean, - end_date: T::Boolean, - first_name: T::Boolean, - income: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Income, - 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, - middle_name: T::Boolean, - start_date: T::Boolean, - title: T::Boolean - } - ) + override.returns( + { + id: T::Boolean, + class_code: T::Boolean, + custom_fields: T::Boolean, + department: + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Department, + employment: + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Employment, + employment_status: T::Boolean, + end_date: T::Boolean, + first_name: T::Boolean, + income: + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Income, + income_history: T::Boolean, + is_active: T::Boolean, + last_name: T::Boolean, + location: + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Location, + manager: + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Manager, + middle_name: T::Boolean, + start_date: T::Boolean, + title: T::Boolean + } + ) + end + def to_hash end - def to_hash; end class Department < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any(T.self_type, FinchAPI::Internal::AnyHash) + end + sig { returns(T.nilable(T::Boolean)) } attr_reader :name @@ -1177,13 +1234,20 @@ module FinchAPI attr_writer :name sig { params(name: T::Boolean).returns(T.attached_class) } - def self.new(name: nil); end + def self.new(name: nil) + end - sig { override.returns({name: T::Boolean}) } - def to_hash; end + sig { override.returns({ name: T::Boolean }) } + def to_hash + end end class Employment < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any(T.self_type, FinchAPI::Internal::AnyHash) + end + sig { returns(T.nilable(T::Boolean)) } attr_reader :subtype @@ -1196,14 +1260,27 @@ module FinchAPI 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); end + sig do + params(subtype: T::Boolean, type: T::Boolean).returns( + T.attached_class + ) + end + def self.new(subtype: nil, type: nil) + end - sig { override.returns({subtype: T::Boolean, type: T::Boolean}) } - def to_hash; end + sig do + override.returns({ subtype: T::Boolean, type: T::Boolean }) + end + def to_hash + end end class Income < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any(T.self_type, FinchAPI::Internal::AnyHash) + end + sig { returns(T.nilable(T::Boolean)) } attr_reader :amount @@ -1223,15 +1300,34 @@ module FinchAPI attr_writer :unit sig do - params(amount: T::Boolean, currency: T::Boolean, unit: T::Boolean).returns(T.attached_class) + 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 - def self.new(amount: nil, currency: nil, unit: nil); end - sig { override.returns({amount: T::Boolean, currency: T::Boolean, unit: T::Boolean}) } - def to_hash; end + sig do + override.returns( + { + amount: T::Boolean, + currency: T::Boolean, + unit: T::Boolean + } + ) + end + def to_hash + end end class Location < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any(T.self_type, FinchAPI::Internal::AnyHash) + end + sig { returns(T.nilable(T::Boolean)) } attr_reader :city @@ -1276,29 +1372,40 @@ module FinchAPI line2: T::Boolean, postal_code: T::Boolean, state: T::Boolean - ) - .returns(T.attached_class) + ).returns(T.attached_class) end - def self.new(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 - override - .returns( - { - city: T::Boolean, - country: T::Boolean, - line1: T::Boolean, - line2: T::Boolean, - postal_code: T::Boolean, - state: T::Boolean - } - ) + override.returns( + { + city: T::Boolean, + country: T::Boolean, + line1: T::Boolean, + line2: T::Boolean, + postal_code: T::Boolean, + state: T::Boolean + } + ) + end + def to_hash end - def to_hash; end end class Manager < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any(T.self_type, FinchAPI::Internal::AnyHash) + end + sig { returns(T.nilable(T::Boolean)) } attr_reader :id @@ -1306,14 +1413,19 @@ module FinchAPI attr_writer :id sig { params(id: T::Boolean).returns(T.attached_class) } - def self.new(id: nil); end + def self.new(id: nil) + end - sig { override.returns({id: T::Boolean}) } - def to_hash; end + sig { override.returns({ id: T::Boolean }) } + def to_hash + end end end class Individual < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + sig { returns(T.nilable(T::Boolean)) } attr_reader :id @@ -1329,7 +1441,7 @@ module FinchAPI sig do returns( T.nilable( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual::Emails + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual::Emails ) ) end @@ -1337,12 +1449,9 @@ module FinchAPI sig do params( - emails: T.any( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual::Emails, - FinchAPI::Internal::AnyHash - ) - ) - .void + emails: + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual::Emails::OrHash + ).void end attr_writer :emails @@ -1385,7 +1494,7 @@ module FinchAPI sig do returns( T.nilable( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual::PhoneNumbers + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual::PhoneNumbers ) ) end @@ -1393,12 +1502,9 @@ module FinchAPI sig do params( - phone_numbers: T.any( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual::PhoneNumbers, - FinchAPI::Internal::AnyHash - ) - ) - .void + phone_numbers: + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual::PhoneNumbers::OrHash + ).void end attr_writer :phone_numbers @@ -1411,7 +1517,7 @@ module FinchAPI sig do returns( T.nilable( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual::Residence + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual::Residence ) ) end @@ -1419,12 +1525,9 @@ module FinchAPI sig do params( - residence: T.any( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual::Residence, - FinchAPI::Internal::AnyHash - ) - ) - .void + residence: + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual::Residence::OrHash + ).void end attr_writer :residence @@ -1438,28 +1541,21 @@ module FinchAPI params( id: T::Boolean, dob: T::Boolean, - emails: T.any( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual::Emails, - FinchAPI::Internal::AnyHash - ), + emails: + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual::Emails::OrHash, encrypted_ssn: T::Boolean, ethnicity: T::Boolean, first_name: T::Boolean, gender: T::Boolean, last_name: T::Boolean, middle_name: T::Boolean, - phone_numbers: T.any( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual::PhoneNumbers, - FinchAPI::Internal::AnyHash - ), + phone_numbers: + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual::PhoneNumbers::OrHash, preferred_name: T::Boolean, - residence: T.any( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual::Residence, - FinchAPI::Internal::AnyHash - ), + residence: + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual::Residence::OrHash, ssn: T::Boolean - ) - .returns(T.attached_class) + ).returns(T.attached_class) end def self.new( id: nil, @@ -1475,30 +1571,40 @@ module FinchAPI preferred_name: nil, residence: nil, ssn: nil - ); end + ) + end + sig do - override - .returns( - { - id: T::Boolean, - dob: T::Boolean, - emails: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual::Emails, - 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, - preferred_name: T::Boolean, - residence: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual::Residence, - ssn: T::Boolean - } - ) + override.returns( + { + id: T::Boolean, + dob: T::Boolean, + emails: + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual::Emails, + 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::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual::PhoneNumbers, + preferred_name: T::Boolean, + residence: + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual::Residence, + ssn: T::Boolean + } + ) + end + def to_hash end - def to_hash; end class Emails < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any(T.self_type, FinchAPI::Internal::AnyHash) + end + sig { returns(T.nilable(T::Boolean)) } attr_reader :data @@ -1511,14 +1617,25 @@ module FinchAPI 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); end + sig do + params(data: T::Boolean, type: T::Boolean).returns( + T.attached_class + ) + end + def self.new(data: nil, type: nil) + end - sig { override.returns({data: T::Boolean, type: T::Boolean}) } - def to_hash; end + sig { override.returns({ data: T::Boolean, type: T::Boolean }) } + def to_hash + end end class PhoneNumbers < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any(T.self_type, FinchAPI::Internal::AnyHash) + end + sig { returns(T.nilable(T::Boolean)) } attr_reader :data @@ -1531,14 +1648,25 @@ module FinchAPI 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); end + sig do + params(data: T::Boolean, type: T::Boolean).returns( + T.attached_class + ) + end + def self.new(data: nil, type: nil) + end - sig { override.returns({data: T::Boolean, type: T::Boolean}) } - def to_hash; end + sig { override.returns({ data: T::Boolean, type: T::Boolean }) } + def to_hash + end end class Residence < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any(T.self_type, FinchAPI::Internal::AnyHash) + end + sig { returns(T.nilable(T::Boolean)) } attr_reader :city @@ -1583,30 +1711,39 @@ module FinchAPI line2: T::Boolean, postal_code: T::Boolean, state: T::Boolean - ) - .returns(T.attached_class) + ).returns(T.attached_class) end - def self.new(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 - override - .returns( - { - city: T::Boolean, - country: T::Boolean, - line1: T::Boolean, - line2: T::Boolean, - postal_code: T::Boolean, - state: T::Boolean - } - ) + override.returns( + { + city: T::Boolean, + country: T::Boolean, + line1: T::Boolean, + line2: T::Boolean, + postal_code: T::Boolean, + state: T::Boolean + } + ) + end + def to_hash end - def to_hash; end end end class PayGroup < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + sig { returns(T.nilable(T::Boolean)) } attr_reader :id @@ -1637,28 +1774,38 @@ module FinchAPI individual_ids: T::Boolean, name: T::Boolean, pay_frequencies: T::Boolean - ) - .returns(T.attached_class) + ).returns(T.attached_class) + end + def self.new( + id: nil, + individual_ids: nil, + name: nil, + pay_frequencies: nil + ) end - def self.new(id: nil, individual_ids: nil, name: nil, pay_frequencies: nil); end sig do - override - .returns({ - id: T::Boolean, - individual_ids: T::Boolean, - name: T::Boolean, - pay_frequencies: T::Boolean - }) - end - def to_hash; end + override.returns( + { + id: T::Boolean, + individual_ids: T::Boolean, + name: T::Boolean, + pay_frequencies: T::Boolean + } + ) + end + def to_hash + end end class PayStatement < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + sig do returns( T.nilable( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::Paging + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::Paging ) ) end @@ -1666,19 +1813,16 @@ module FinchAPI sig do params( - paging: T.any( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::Paging, - FinchAPI::Internal::AnyHash - ) - ) - .void + paging: + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::Paging::OrHash + ).void end attr_writer :paging sig do returns( T.nilable( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements ) ) end @@ -1686,60 +1830,73 @@ module FinchAPI sig do params( - pay_statements: T.any( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements, - FinchAPI::Internal::AnyHash - ) - ) - .void + pay_statements: + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::OrHash + ).void end attr_writer :pay_statements sig do params( - paging: T.any( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::Paging, - FinchAPI::Internal::AnyHash - ), - pay_statements: T.any( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements, - FinchAPI::Internal::AnyHash - ) - ) - .returns(T.attached_class) + paging: + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::Paging::OrHash, + pay_statements: + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::OrHash + ).returns(T.attached_class) + end + def self.new(paging: nil, pay_statements: nil) end - def self.new(paging: nil, pay_statements: nil); end sig do - override - .returns( - { - paging: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::Paging, - pay_statements: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements - } - ) + override.returns( + { + paging: + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::Paging, + pay_statements: + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements + } + ) + end + def to_hash end - def to_hash; end class Paging < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any(T.self_type, FinchAPI::Internal::AnyHash) + end + sig { returns(T::Boolean) } attr_accessor :count sig { returns(T::Boolean) } attr_accessor :offset - sig { params(count: T::Boolean, offset: T::Boolean).returns(T.attached_class) } - def self.new(count:, offset:); end + sig do + params(count: T::Boolean, offset: T::Boolean).returns( + T.attached_class + ) + end + def self.new(count:, offset:) + end - sig { override.returns({count: T::Boolean, offset: T::Boolean}) } - def to_hash; end + sig do + override.returns({ count: T::Boolean, offset: T::Boolean }) + end + def to_hash + end end class PayStatements < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any(T.self_type, FinchAPI::Internal::AnyHash) + end + sig do returns( T.nilable( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Earnings + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Earnings ) ) end @@ -1747,19 +1904,16 @@ module FinchAPI sig do params( - earnings: T.any( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Earnings, - FinchAPI::Internal::AnyHash - ) - ) - .void + earnings: + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Earnings::OrHash + ).void end attr_writer :earnings sig do returns( T.nilable( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployeeDeductions + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployeeDeductions ) ) end @@ -1767,19 +1921,16 @@ module FinchAPI sig do params( - employee_deductions: T.any( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployeeDeductions, - FinchAPI::Internal::AnyHash - ) - ) - .void + employee_deductions: + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployeeDeductions::OrHash + ).void end attr_writer :employee_deductions sig do returns( T.nilable( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployerContributions + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployerContributions ) ) end @@ -1787,12 +1938,9 @@ module FinchAPI sig do params( - employer_contributions: T.any( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployerContributions, - FinchAPI::Internal::AnyHash - ) - ) - .void + employer_contributions: + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployerContributions::OrHash + ).void end attr_writer :employer_contributions @@ -1823,7 +1971,7 @@ module FinchAPI sig do returns( T.nilable( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Taxes + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Taxes ) ) end @@ -1831,12 +1979,9 @@ module FinchAPI sig do params( - taxes: T.any( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Taxes, - FinchAPI::Internal::AnyHash - ) - ) - .void + taxes: + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Taxes::OrHash + ).void end attr_writer :taxes @@ -1854,30 +1999,21 @@ module FinchAPI sig do params( - earnings: T.any( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Earnings, - FinchAPI::Internal::AnyHash - ), - employee_deductions: T.any( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployeeDeductions, - FinchAPI::Internal::AnyHash - ), - employer_contributions: T.any( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployerContributions, - FinchAPI::Internal::AnyHash - ), + earnings: + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Earnings::OrHash, + employee_deductions: + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployeeDeductions::OrHash, + employer_contributions: + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployerContributions::OrHash, gross_pay: T::Boolean, individual_id: T::Boolean, net_pay: T::Boolean, payment_method: T::Boolean, - taxes: T.any( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Taxes, - FinchAPI::Internal::AnyHash - ), + taxes: + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Taxes::OrHash, total_hours: T::Boolean, type: T::Boolean - ) - .returns(T.attached_class) + ).returns(T.attached_class) end def self.new( earnings: nil, @@ -1890,27 +2026,38 @@ module FinchAPI taxes: nil, total_hours: nil, type: nil - ); end + ) + end + sig do - override - .returns( - { - 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: T::Boolean, - individual_id: T::Boolean, - net_pay: T::Boolean, - payment_method: T::Boolean, - taxes: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Taxes, - total_hours: T::Boolean, - type: T::Boolean - } - ) + override.returns( + { + earnings: + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Earnings, + employee_deductions: + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployeeDeductions, + employer_contributions: + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployerContributions, + gross_pay: T::Boolean, + individual_id: T::Boolean, + net_pay: T::Boolean, + payment_method: T::Boolean, + taxes: + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Taxes, + total_hours: T::Boolean, + type: T::Boolean + } + ) + end + def to_hash end - def to_hash; end class Earnings < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any(T.self_type, FinchAPI::Internal::AnyHash) + end + sig { returns(T.nilable(T::Boolean)) } attr_reader :amount @@ -1936,10 +2083,15 @@ module FinchAPI attr_writer :type sig do - params(amount: T::Boolean, currency: T::Boolean, name: T::Boolean, type: T::Boolean) - .returns(T.attached_class) + params( + amount: T::Boolean, + currency: T::Boolean, + name: T::Boolean, + type: T::Boolean + ).returns(T.attached_class) + end + def self.new(amount: nil, currency: nil, name: nil, type: nil) end - def self.new(amount: nil, currency: nil, name: nil, type: nil); end sig do override.returns( @@ -1951,10 +2103,16 @@ module FinchAPI } ) end - def to_hash; end + def to_hash + end end class EmployeeDeductions < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any(T.self_type, FinchAPI::Internal::AnyHash) + end + sig { returns(T.nilable(T::Boolean)) } attr_reader :amount @@ -1992,27 +2150,38 @@ module FinchAPI name: T::Boolean, pre_tax: T::Boolean, type: T::Boolean - ) - .returns(T.attached_class) + ).returns(T.attached_class) + end + def self.new( + amount: nil, + currency: nil, + name: nil, + pre_tax: nil, + type: nil + ) end - def self.new(amount: nil, currency: nil, name: nil, pre_tax: nil, type: nil); end sig do - override - .returns( - { - amount: T::Boolean, - currency: T::Boolean, - name: T::Boolean, - pre_tax: T::Boolean, - type: T::Boolean - } - ) + override.returns( + { + amount: T::Boolean, + currency: T::Boolean, + name: T::Boolean, + pre_tax: T::Boolean, + type: T::Boolean + } + ) + end + def to_hash end - def to_hash; end end class EmployerContributions < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any(T.self_type, FinchAPI::Internal::AnyHash) + end + sig { returns(T.nilable(T::Boolean)) } attr_reader :amount @@ -2038,13 +2207,28 @@ module FinchAPI name: T::Boolean ).returns(T.attached_class) end - def self.new(amount: nil, currency: nil, name: nil); end + def self.new(amount: nil, currency: nil, name: nil) + end - sig { override.returns({amount: T::Boolean, currency: T::Boolean, name: T::Boolean}) } - def to_hash; end + sig do + override.returns( + { + amount: T::Boolean, + currency: T::Boolean, + name: T::Boolean + } + ) + end + def to_hash + end end class Taxes < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any(T.self_type, FinchAPI::Internal::AnyHash) + end + sig { returns(T.nilable(T::Boolean)) } attr_reader :amount @@ -2082,29 +2266,38 @@ module FinchAPI employer: T::Boolean, name: T::Boolean, type: T::Boolean - ) - .returns(T.attached_class) + ).returns(T.attached_class) + end + def self.new( + amount: nil, + currency: nil, + employer: nil, + name: nil, + type: nil + ) end - def self.new(amount: nil, currency: nil, employer: nil, name: nil, type: nil); end sig do - override - .returns( - { - amount: T::Boolean, - currency: T::Boolean, - employer: T::Boolean, - name: T::Boolean, - type: T::Boolean - } - ) + override.returns( + { + amount: T::Boolean, + currency: T::Boolean, + employer: T::Boolean, + name: T::Boolean, + type: T::Boolean + } + ) + end + def to_hash end - def to_hash; end end end end class Payment < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + sig { returns(T.nilable(T::Boolean)) } attr_reader :id @@ -2174,7 +2367,7 @@ module FinchAPI sig do returns( T.nilable( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Payment::PayPeriod + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Payment::PayPeriod ) ) end @@ -2182,12 +2375,9 @@ module FinchAPI sig do params( - pay_period: T.any( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Payment::PayPeriod, - FinchAPI::Internal::AnyHash - ) - ) - .void + pay_period: + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Payment::PayPeriod::OrHash + ).void end attr_writer :pay_period @@ -2204,12 +2394,9 @@ module FinchAPI pay_date: T::Boolean, pay_frequencies: T::Boolean, pay_group_ids: T::Boolean, - pay_period: T.any( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Payment::PayPeriod, - FinchAPI::Internal::AnyHash - ) - ) - .returns(T.attached_class) + pay_period: + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Payment::PayPeriod::OrHash + ).returns(T.attached_class) end def self.new( id: nil, @@ -2224,29 +2411,37 @@ module FinchAPI pay_frequencies: nil, pay_group_ids: nil, pay_period: nil - ); end + ) + end + sig do - override - .returns( - { - id: T::Boolean, - company_debit: T::Boolean, - debit_date: T::Boolean, - employee_taxes: T::Boolean, - employer_taxes: T::Boolean, - gross_pay: T::Boolean, - individual_ids: T::Boolean, - net_pay: T::Boolean, - pay_date: T::Boolean, - pay_frequencies: T::Boolean, - pay_group_ids: T::Boolean, - pay_period: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Payment::PayPeriod - } - ) + override.returns( + { + id: T::Boolean, + company_debit: T::Boolean, + debit_date: T::Boolean, + employee_taxes: T::Boolean, + employer_taxes: T::Boolean, + gross_pay: T::Boolean, + individual_ids: T::Boolean, + net_pay: T::Boolean, + pay_date: T::Boolean, + pay_frequencies: T::Boolean, + pay_group_ids: T::Boolean, + pay_period: + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Payment::PayPeriod + } + ) + end + def to_hash end - def to_hash; end class PayPeriod < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any(T.self_type, FinchAPI::Internal::AnyHash) + end + sig { returns(T.nilable(T::Boolean)) } attr_reader :end_date @@ -2259,11 +2454,21 @@ module FinchAPI 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); end + sig do + params(end_date: T::Boolean, start_date: T::Boolean).returns( + T.attached_class + ) + end + def self.new(end_date: nil, start_date: nil) + end - sig { override.returns({end_date: T::Boolean, start_date: T::Boolean}) } - def to_hash; end + sig do + override.returns( + { end_date: T::Boolean, start_date: T::Boolean } + ) + end + def to_hash + end end end end @@ -2273,28 +2478,49 @@ module FinchAPI extend FinchAPI::Internal::Type::Enum TaggedSymbol = - T.type_alias { T.all(Symbol, FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::Type) } + T.type_alias do + T.all( + Symbol, + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::Type + ) + end OrSymbol = T.type_alias { T.any(Symbol, String) } ASSISTED = - T.let(:assisted, FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::Type::TaggedSymbol) + T.let( + :assisted, + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::Type::TaggedSymbol + ) CREDENTIAL = - T.let(:credential, FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::Type::TaggedSymbol) + T.let( + :credential, + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::Type::TaggedSymbol + ) API_TOKEN = - T.let(:api_token, FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::Type::TaggedSymbol) + T.let( + :api_token, + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::Type::TaggedSymbol + ) API_CREDENTIAL = T.let( :api_credential, - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::Type::TaggedSymbol + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::Type::TaggedSymbol ) OAUTH = - T.let(:oauth, FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::Type::TaggedSymbol) + T.let( + :oauth, + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::Type::TaggedSymbol + ) sig do - override - .returns(T::Array[FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::Type::TaggedSymbol]) + override.returns( + T::Array[ + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::Type::TaggedSymbol + ] + ) + end + def self.values end - def self.values; end end end end @@ -2302,14 +2528,25 @@ module FinchAPI module EventType extend FinchAPI::Internal::Type::Enum - TaggedSymbol = T.type_alias { T.all(Symbol, FinchAPI::Models::AccountUpdateEvent::EventType) } + TaggedSymbol = + T.type_alias do + T.all(Symbol, FinchAPI::AccountUpdateEvent::EventType) + end OrSymbol = T.type_alias { T.any(Symbol, String) } ACCOUNT_UPDATED = - T.let(:"account.updated", FinchAPI::Models::AccountUpdateEvent::EventType::TaggedSymbol) + T.let( + :"account.updated", + FinchAPI::AccountUpdateEvent::EventType::TaggedSymbol + ) - sig { override.returns(T::Array[FinchAPI::Models::AccountUpdateEvent::EventType::TaggedSymbol]) } - def self.values; end + sig do + override.returns( + T::Array[FinchAPI::AccountUpdateEvent::EventType::TaggedSymbol] + ) + end + def self.values + end end end end diff --git a/rbi/finch_api/models/base_webhook_event.rbi b/rbi/finch_api/models/base_webhook_event.rbi index 28b132fc..cfb68aa0 100644 --- a/rbi/finch_api/models/base_webhook_event.rbi +++ b/rbi/finch_api/models/base_webhook_event.rbi @@ -3,6 +3,8 @@ module FinchAPI module Models class BaseWebhookEvent < FinchAPI::Internal::Type::BaseModel + OrHash = T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + # [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. @@ -21,7 +23,13 @@ module FinchAPI 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) } + sig do + params( + account_id: String, + company_id: String, + connection_id: String + ).returns(T.attached_class) + end def self.new( # [DEPRECATED] Unique Finch ID of the employer account used to make this # connection. Use `connection_id` instead to identify the connection associated @@ -32,9 +40,16 @@ module FinchAPI company_id:, # Unique Finch ID of the connection associated with the webhook event. connection_id: nil - ); end - sig { override.returns({account_id: String, company_id: String, connection_id: String}) } - def to_hash; end + ) + end + + sig do + override.returns( + { account_id: String, company_id: String, connection_id: String } + ) + end + def to_hash + end end end end diff --git a/rbi/finch_api/models/company_event.rbi b/rbi/finch_api/models/company_event.rbi index 3c45659a..486c50d5 100644 --- a/rbi/finch_api/models/company_event.rbi +++ b/rbi/finch_api/models/company_event.rbi @@ -3,45 +3,61 @@ module FinchAPI module Models class CompanyEvent < FinchAPI::Models::BaseWebhookEvent + OrHash = T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + sig { returns(T.nilable(T::Hash[Symbol, T.anything])) } attr_accessor :data - sig { returns(T.nilable(FinchAPI::Models::CompanyEvent::EventType::TaggedSymbol)) } + sig do + returns(T.nilable(FinchAPI::CompanyEvent::EventType::TaggedSymbol)) + end attr_reader :event_type - sig { params(event_type: FinchAPI::Models::CompanyEvent::EventType::OrSymbol).void } + sig do + params(event_type: FinchAPI::CompanyEvent::EventType::OrSymbol).void + end attr_writer :event_type sig do params( data: T.nilable(T::Hash[Symbol, T.anything]), - event_type: FinchAPI::Models::CompanyEvent::EventType::OrSymbol - ) - .returns(T.attached_class) + event_type: FinchAPI::CompanyEvent::EventType::OrSymbol + ).returns(T.attached_class) + end + def self.new(data: nil, event_type: nil) end - def self.new(data: nil, event_type: nil); end sig do - override - .returns( - { - data: T.nilable(T::Hash[Symbol, T.anything]), - event_type: FinchAPI::Models::CompanyEvent::EventType::TaggedSymbol - } - ) + override.returns( + { + data: T.nilable(T::Hash[Symbol, T.anything]), + event_type: FinchAPI::CompanyEvent::EventType::TaggedSymbol + } + ) + end + def to_hash end - def to_hash; end module EventType extend FinchAPI::Internal::Type::Enum - TaggedSymbol = T.type_alias { T.all(Symbol, FinchAPI::Models::CompanyEvent::EventType) } + TaggedSymbol = + T.type_alias { T.all(Symbol, FinchAPI::CompanyEvent::EventType) } OrSymbol = T.type_alias { T.any(Symbol, String) } - COMPANY_UPDATED = T.let(:"company.updated", FinchAPI::Models::CompanyEvent::EventType::TaggedSymbol) + COMPANY_UPDATED = + T.let( + :"company.updated", + FinchAPI::CompanyEvent::EventType::TaggedSymbol + ) - sig { override.returns(T::Array[FinchAPI::Models::CompanyEvent::EventType::TaggedSymbol]) } - def self.values; end + sig do + override.returns( + T::Array[FinchAPI::CompanyEvent::EventType::TaggedSymbol] + ) + end + def self.values + end end end end diff --git a/rbi/finch_api/models/connect/session_new_params.rbi b/rbi/finch_api/models/connect/session_new_params.rbi index b71fc21e..829bd584 100644 --- a/rbi/finch_api/models/connect/session_new_params.rbi +++ b/rbi/finch_api/models/connect/session_new_params.rbi @@ -7,26 +7,37 @@ module FinchAPI extend FinchAPI::Internal::Type::RequestParameters::Converter include FinchAPI::Internal::Type::RequestParameters + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + sig { returns(String) } attr_accessor :customer_id sig { returns(String) } attr_accessor :customer_name - sig { returns(T::Array[FinchAPI::Models::Connect::SessionNewParams::Product::OrSymbol]) } + sig do + returns( + T::Array[FinchAPI::Connect::SessionNewParams::Product::OrSymbol] + ) + end attr_accessor :products sig { returns(T.nilable(String)) } attr_accessor :customer_email - sig { returns(T.nilable(FinchAPI::Models::Connect::SessionNewParams::Integration)) } + sig do + returns(T.nilable(FinchAPI::Connect::SessionNewParams::Integration)) + end attr_reader :integration sig do params( - integration: T.nilable(T.any(FinchAPI::Models::Connect::SessionNewParams::Integration, FinchAPI::Internal::AnyHash)) - ) - .void + integration: + T.nilable( + FinchAPI::Connect::SessionNewParams::Integration::OrHash + ) + ).void end attr_writer :integration @@ -41,23 +52,31 @@ module FinchAPI sig { returns(T.nilable(String)) } attr_accessor :redirect_uri - sig { returns(T.nilable(FinchAPI::Models::Connect::SessionNewParams::Sandbox::OrSymbol)) } + sig do + returns( + T.nilable(FinchAPI::Connect::SessionNewParams::Sandbox::OrSymbol) + ) + end attr_accessor :sandbox sig do params( customer_id: String, customer_name: String, - products: T::Array[FinchAPI::Models::Connect::SessionNewParams::Product::OrSymbol], + products: + T::Array[FinchAPI::Connect::SessionNewParams::Product::OrSymbol], customer_email: T.nilable(String), - integration: T.nilable(T.any(FinchAPI::Models::Connect::SessionNewParams::Integration, FinchAPI::Internal::AnyHash)), + integration: + T.nilable( + FinchAPI::Connect::SessionNewParams::Integration::OrHash + ), 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, FinchAPI::Internal::AnyHash) - ) - .returns(T.attached_class) + sandbox: + T.nilable(FinchAPI::Connect::SessionNewParams::Sandbox::OrSymbol), + request_options: FinchAPI::RequestOptions::OrHash + ).returns(T.attached_class) end def self.new( customer_id:, @@ -72,50 +91,118 @@ module FinchAPI redirect_uri: nil, sandbox: nil, request_options: {} - ); end + ) + end + sig do - override - .returns( - { - customer_id: String, - 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), - 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: FinchAPI::RequestOptions - } - ) + override.returns( + { + customer_id: String, + customer_name: String, + products: + T::Array[ + FinchAPI::Connect::SessionNewParams::Product::OrSymbol + ], + customer_email: T.nilable(String), + integration: + T.nilable(FinchAPI::Connect::SessionNewParams::Integration), + manual: T.nilable(T::Boolean), + minutes_to_expire: T.nilable(Float), + redirect_uri: T.nilable(String), + sandbox: + T.nilable( + FinchAPI::Connect::SessionNewParams::Sandbox::OrSymbol + ), + request_options: FinchAPI::RequestOptions + } + ) + end + def to_hash end - def to_hash; end # The Finch products that can be requested during the Connect flow. module Product extend FinchAPI::Internal::Type::Enum - TaggedSymbol = T.type_alias { T.all(Symbol, FinchAPI::Models::Connect::SessionNewParams::Product) } + TaggedSymbol = + T.type_alias do + T.all(Symbol, FinchAPI::Connect::SessionNewParams::Product) + end OrSymbol = T.type_alias { T.any(Symbol, String) } - 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) - DEDUCTION = T.let(:deduction, FinchAPI::Models::Connect::SessionNewParams::Product::TaggedSymbol) - DOCUMENTS = T.let(:documents, FinchAPI::Models::Connect::SessionNewParams::Product::TaggedSymbol) - - sig { override.returns(T::Array[FinchAPI::Models::Connect::SessionNewParams::Product::TaggedSymbol]) } - def self.values; end + COMPANY = + T.let( + :company, + FinchAPI::Connect::SessionNewParams::Product::TaggedSymbol + ) + DIRECTORY = + T.let( + :directory, + FinchAPI::Connect::SessionNewParams::Product::TaggedSymbol + ) + INDIVIDUAL = + T.let( + :individual, + FinchAPI::Connect::SessionNewParams::Product::TaggedSymbol + ) + EMPLOYMENT = + T.let( + :employment, + FinchAPI::Connect::SessionNewParams::Product::TaggedSymbol + ) + PAYMENT = + T.let( + :payment, + FinchAPI::Connect::SessionNewParams::Product::TaggedSymbol + ) + PAY_STATEMENT = + T.let( + :pay_statement, + FinchAPI::Connect::SessionNewParams::Product::TaggedSymbol + ) + BENEFITS = + T.let( + :benefits, + FinchAPI::Connect::SessionNewParams::Product::TaggedSymbol + ) + SSN = + T.let( + :ssn, + FinchAPI::Connect::SessionNewParams::Product::TaggedSymbol + ) + DEDUCTION = + T.let( + :deduction, + FinchAPI::Connect::SessionNewParams::Product::TaggedSymbol + ) + DOCUMENTS = + T.let( + :documents, + FinchAPI::Connect::SessionNewParams::Product::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + FinchAPI::Connect::SessionNewParams::Product::TaggedSymbol + ] + ) + end + def self.values + end end class Integration < FinchAPI::Internal::Type::BaseModel - sig { returns(T.nilable(FinchAPI::Models::Connect::SessionNewParams::Integration::AuthMethod::OrSymbol)) } + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + + sig do + returns( + T.nilable( + FinchAPI::Connect::SessionNewParams::Integration::AuthMethod::OrSymbol + ) + ) + end attr_accessor :auth_method sig { returns(T.nilable(String)) } @@ -123,58 +210,104 @@ module FinchAPI sig do params( - auth_method: T.nilable(FinchAPI::Models::Connect::SessionNewParams::Integration::AuthMethod::OrSymbol), + auth_method: + T.nilable( + FinchAPI::Connect::SessionNewParams::Integration::AuthMethod::OrSymbol + ), provider: T.nilable(String) - ) - .returns(T.attached_class) + ).returns(T.attached_class) + end + def self.new(auth_method: nil, provider: nil) end - def self.new(auth_method: nil, provider: nil); end sig do - override - .returns( - { - auth_method: T.nilable(FinchAPI::Models::Connect::SessionNewParams::Integration::AuthMethod::OrSymbol), - provider: T.nilable(String) - } - ) + override.returns( + { + auth_method: + T.nilable( + FinchAPI::Connect::SessionNewParams::Integration::AuthMethod::OrSymbol + ), + provider: T.nilable(String) + } + ) + end + def to_hash end - def to_hash; end module AuthMethod extend FinchAPI::Internal::Type::Enum TaggedSymbol = - T.type_alias { T.all(Symbol, FinchAPI::Models::Connect::SessionNewParams::Integration::AuthMethod) } + T.type_alias do + T.all( + Symbol, + FinchAPI::Connect::SessionNewParams::Integration::AuthMethod + ) + end OrSymbol = T.type_alias { T.any(Symbol, String) } ASSISTED = - T.let(:assisted, FinchAPI::Models::Connect::SessionNewParams::Integration::AuthMethod::TaggedSymbol) + T.let( + :assisted, + FinchAPI::Connect::SessionNewParams::Integration::AuthMethod::TaggedSymbol + ) CREDENTIAL = - T.let(:credential, FinchAPI::Models::Connect::SessionNewParams::Integration::AuthMethod::TaggedSymbol) - OAUTH = T.let(:oauth, FinchAPI::Models::Connect::SessionNewParams::Integration::AuthMethod::TaggedSymbol) + T.let( + :credential, + FinchAPI::Connect::SessionNewParams::Integration::AuthMethod::TaggedSymbol + ) + OAUTH = + T.let( + :oauth, + FinchAPI::Connect::SessionNewParams::Integration::AuthMethod::TaggedSymbol + ) API_TOKEN = - T.let(:api_token, FinchAPI::Models::Connect::SessionNewParams::Integration::AuthMethod::TaggedSymbol) + T.let( + :api_token, + FinchAPI::Connect::SessionNewParams::Integration::AuthMethod::TaggedSymbol + ) sig do - override - .returns(T::Array[FinchAPI::Models::Connect::SessionNewParams::Integration::AuthMethod::TaggedSymbol]) + override.returns( + T::Array[ + FinchAPI::Connect::SessionNewParams::Integration::AuthMethod::TaggedSymbol + ] + ) + end + def self.values end - def self.values; end end end module Sandbox extend FinchAPI::Internal::Type::Enum - TaggedSymbol = T.type_alias { T.all(Symbol, FinchAPI::Models::Connect::SessionNewParams::Sandbox) } + TaggedSymbol = + T.type_alias do + T.all(Symbol, FinchAPI::Connect::SessionNewParams::Sandbox) + end OrSymbol = T.type_alias { T.any(Symbol, String) } - FINCH = T.let(:finch, FinchAPI::Models::Connect::SessionNewParams::Sandbox::TaggedSymbol) - PROVIDER = T.let(:provider, FinchAPI::Models::Connect::SessionNewParams::Sandbox::TaggedSymbol) + FINCH = + T.let( + :finch, + FinchAPI::Connect::SessionNewParams::Sandbox::TaggedSymbol + ) + PROVIDER = + T.let( + :provider, + FinchAPI::Connect::SessionNewParams::Sandbox::TaggedSymbol + ) - sig { override.returns(T::Array[FinchAPI::Models::Connect::SessionNewParams::Sandbox::TaggedSymbol]) } - def self.values; end + sig do + override.returns( + T::Array[ + FinchAPI::Connect::SessionNewParams::Sandbox::TaggedSymbol + ] + ) + end + def self.values + end end end end diff --git a/rbi/finch_api/models/connect/session_new_response.rbi b/rbi/finch_api/models/connect/session_new_response.rbi index ad3bdf70..47c0bc00 100644 --- a/rbi/finch_api/models/connect/session_new_response.rbi +++ b/rbi/finch_api/models/connect/session_new_response.rbi @@ -4,6 +4,9 @@ module FinchAPI module Models module Connect class SessionNewResponse < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + # The Connect URL to redirect the user to for authentication sig { returns(String) } attr_accessor :connect_url @@ -12,15 +15,22 @@ module FinchAPI sig { returns(String) } attr_accessor :session_id - sig { params(connect_url: String, session_id: String).returns(T.attached_class) } + sig do + params(connect_url: String, session_id: String).returns( + T.attached_class + ) + end def self.new( # The Connect URL to redirect the user to for authentication connect_url:, # The unique identifier for the created connect session session_id: - ); end - sig { override.returns({connect_url: String, session_id: String}) } - def to_hash; end + ) + end + + sig { override.returns({ connect_url: String, session_id: String }) } + def to_hash + end end end end diff --git a/rbi/finch_api/models/connect/session_reauthenticate_params.rbi b/rbi/finch_api/models/connect/session_reauthenticate_params.rbi index d7cef6ee..e26e1043 100644 --- a/rbi/finch_api/models/connect/session_reauthenticate_params.rbi +++ b/rbi/finch_api/models/connect/session_reauthenticate_params.rbi @@ -7,6 +7,9 @@ module FinchAPI extend FinchAPI::Internal::Type::RequestParameters::Converter include FinchAPI::Internal::Type::RequestParameters + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + # The ID of the existing connection to reauthenticate sig { returns(String) } attr_accessor :connection_id @@ -17,7 +20,15 @@ module FinchAPI 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])) } + sig do + returns( + T.nilable( + T::Array[ + FinchAPI::Connect::SessionReauthenticateParams::Product::OrSymbol + ] + ) + ) + end attr_accessor :products # The URI to redirect to after the Connect flow is completed @@ -28,11 +39,15 @@ module FinchAPI params( connection_id: String, minutes_to_expire: T.nilable(Integer), - products: T.nilable(T::Array[FinchAPI::Models::Connect::SessionReauthenticateParams::Product::OrSymbol]), + products: + T.nilable( + T::Array[ + FinchAPI::Connect::SessionReauthenticateParams::Product::OrSymbol + ] + ), redirect_uri: T.nilable(String), - request_options: T.any(FinchAPI::RequestOptions, FinchAPI::Internal::AnyHash) - ) - .returns(T.attached_class) + request_options: FinchAPI::RequestOptions::OrHash + ).returns(T.attached_class) end def self.new( # The ID of the existing connection to reauthenticate @@ -45,49 +60,101 @@ module FinchAPI # The URI to redirect to after the Connect flow is completed redirect_uri: nil, request_options: {} - ); end + ) + end + sig do - override - .returns( - { - connection_id: String, - minutes_to_expire: T.nilable(Integer), - products: T.nilable(T::Array[FinchAPI::Models::Connect::SessionReauthenticateParams::Product::OrSymbol]), - redirect_uri: T.nilable(String), - request_options: FinchAPI::RequestOptions - } - ) + override.returns( + { + connection_id: String, + minutes_to_expire: T.nilable(Integer), + products: + T.nilable( + T::Array[ + FinchAPI::Connect::SessionReauthenticateParams::Product::OrSymbol + ] + ), + redirect_uri: T.nilable(String), + request_options: FinchAPI::RequestOptions + } + ) + end + def to_hash end - def to_hash; end # The Finch products that can be requested during the Connect flow. module Product extend FinchAPI::Internal::Type::Enum TaggedSymbol = - T.type_alias { T.all(Symbol, FinchAPI::Models::Connect::SessionReauthenticateParams::Product) } + T.type_alias do + T.all( + Symbol, + FinchAPI::Connect::SessionReauthenticateParams::Product + ) + end OrSymbol = T.type_alias { T.any(Symbol, String) } - COMPANY = T.let(:company, FinchAPI::Models::Connect::SessionReauthenticateParams::Product::TaggedSymbol) + COMPANY = + T.let( + :company, + FinchAPI::Connect::SessionReauthenticateParams::Product::TaggedSymbol + ) DIRECTORY = - T.let(:directory, FinchAPI::Models::Connect::SessionReauthenticateParams::Product::TaggedSymbol) + T.let( + :directory, + FinchAPI::Connect::SessionReauthenticateParams::Product::TaggedSymbol + ) INDIVIDUAL = - T.let(:individual, FinchAPI::Models::Connect::SessionReauthenticateParams::Product::TaggedSymbol) + T.let( + :individual, + FinchAPI::Connect::SessionReauthenticateParams::Product::TaggedSymbol + ) EMPLOYMENT = - T.let(:employment, FinchAPI::Models::Connect::SessionReauthenticateParams::Product::TaggedSymbol) - PAYMENT = T.let(:payment, FinchAPI::Models::Connect::SessionReauthenticateParams::Product::TaggedSymbol) + T.let( + :employment, + FinchAPI::Connect::SessionReauthenticateParams::Product::TaggedSymbol + ) + PAYMENT = + T.let( + :payment, + FinchAPI::Connect::SessionReauthenticateParams::Product::TaggedSymbol + ) PAY_STATEMENT = - T.let(:pay_statement, FinchAPI::Models::Connect::SessionReauthenticateParams::Product::TaggedSymbol) + T.let( + :pay_statement, + FinchAPI::Connect::SessionReauthenticateParams::Product::TaggedSymbol + ) BENEFITS = - T.let(:benefits, FinchAPI::Models::Connect::SessionReauthenticateParams::Product::TaggedSymbol) - SSN = T.let(:ssn, FinchAPI::Models::Connect::SessionReauthenticateParams::Product::TaggedSymbol) + T.let( + :benefits, + FinchAPI::Connect::SessionReauthenticateParams::Product::TaggedSymbol + ) + SSN = + T.let( + :ssn, + FinchAPI::Connect::SessionReauthenticateParams::Product::TaggedSymbol + ) DEDUCTION = - T.let(:deduction, FinchAPI::Models::Connect::SessionReauthenticateParams::Product::TaggedSymbol) + T.let( + :deduction, + FinchAPI::Connect::SessionReauthenticateParams::Product::TaggedSymbol + ) DOCUMENTS = - T.let(:documents, FinchAPI::Models::Connect::SessionReauthenticateParams::Product::TaggedSymbol) + T.let( + :documents, + FinchAPI::Connect::SessionReauthenticateParams::Product::TaggedSymbol + ) - sig { override.returns(T::Array[FinchAPI::Models::Connect::SessionReauthenticateParams::Product::TaggedSymbol]) } - def self.values; end + sig do + override.returns( + T::Array[ + FinchAPI::Connect::SessionReauthenticateParams::Product::TaggedSymbol + ] + ) + end + def self.values + end end end end diff --git a/rbi/finch_api/models/connect/session_reauthenticate_response.rbi b/rbi/finch_api/models/connect/session_reauthenticate_response.rbi index d872dfad..2a990f38 100644 --- a/rbi/finch_api/models/connect/session_reauthenticate_response.rbi +++ b/rbi/finch_api/models/connect/session_reauthenticate_response.rbi @@ -4,6 +4,9 @@ module FinchAPI module Models module Connect class SessionReauthenticateResponse < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + # The Connect URL to redirect the user to for reauthentication sig { returns(String) } attr_accessor :connect_url @@ -12,15 +15,22 @@ module FinchAPI sig { returns(String) } attr_accessor :session_id - sig { params(connect_url: String, session_id: String).returns(T.attached_class) } + sig do + params(connect_url: String, session_id: String).returns( + T.attached_class + ) + end def self.new( # The Connect URL to redirect the user to for reauthentication connect_url:, # The unique identifier for the created connect session session_id: - ); end - sig { override.returns({connect_url: String, session_id: String}) } - def to_hash; end + ) + end + + sig { override.returns({ connect_url: String, session_id: String }) } + def to_hash + end end end end diff --git a/rbi/finch_api/models/connection_status_type.rbi b/rbi/finch_api/models/connection_status_type.rbi index 16851dcd..4c786ff7 100644 --- a/rbi/finch_api/models/connection_status_type.rbi +++ b/rbi/finch_api/models/connection_status_type.rbi @@ -5,19 +5,29 @@ module FinchAPI module ConnectionStatusType extend FinchAPI::Internal::Type::Enum - TaggedSymbol = T.type_alias { T.all(Symbol, FinchAPI::Models::ConnectionStatusType) } + TaggedSymbol = + T.type_alias { T.all(Symbol, FinchAPI::ConnectionStatusType) } OrSymbol = T.type_alias { T.any(Symbol, String) } - PENDING = T.let(:pending, FinchAPI::Models::ConnectionStatusType::TaggedSymbol) - PROCESSING = T.let(:processing, FinchAPI::Models::ConnectionStatusType::TaggedSymbol) - CONNECTED = T.let(:connected, FinchAPI::Models::ConnectionStatusType::TaggedSymbol) + PENDING = T.let(:pending, FinchAPI::ConnectionStatusType::TaggedSymbol) + PROCESSING = + T.let(:processing, FinchAPI::ConnectionStatusType::TaggedSymbol) + CONNECTED = + T.let(:connected, FinchAPI::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) + T.let( + :error_no_account_setup, + FinchAPI::ConnectionStatusType::TaggedSymbol + ) + ERROR_PERMISSIONS = + T.let(:error_permissions, FinchAPI::ConnectionStatusType::TaggedSymbol) + REAUTH = T.let(:reauth, FinchAPI::ConnectionStatusType::TaggedSymbol) - sig { override.returns(T::Array[FinchAPI::Models::ConnectionStatusType::TaggedSymbol]) } - def self.values; end + sig do + override.returns(T::Array[FinchAPI::ConnectionStatusType::TaggedSymbol]) + end + def self.values + end end end end diff --git a/rbi/finch_api/models/create_access_token_response.rbi b/rbi/finch_api/models/create_access_token_response.rbi index 2e99f04d..b83caaf5 100644 --- a/rbi/finch_api/models/create_access_token_response.rbi +++ b/rbi/finch_api/models/create_access_token_response.rbi @@ -3,6 +3,8 @@ module FinchAPI module Models class CreateAccessTokenResponse < FinchAPI::Internal::Type::BaseModel + OrHash = T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + # The access token for the connection. sig { returns(String) } attr_accessor :access_token @@ -13,7 +15,9 @@ module FinchAPI attr_accessor :account_id # The type of application associated with a token. - sig { returns(FinchAPI::Models::CreateAccessTokenResponse::ClientType::TaggedSymbol) } + sig do + returns(FinchAPI::CreateAccessTokenResponse::ClientType::TaggedSymbol) + end attr_accessor :client_type # [DEPRECATED] Use `connection_id` to identify the connection instead of this @@ -29,7 +33,11 @@ module FinchAPI # # - `provider` - connection to an external provider # - `finch` - finch-generated data. - sig { returns(FinchAPI::Models::CreateAccessTokenResponse::ConnectionType::TaggedSymbol) } + sig do + returns( + FinchAPI::CreateAccessTokenResponse::ConnectionType::TaggedSymbol + ) + end attr_accessor :connection_type # An array of the authorized products associated with the `access_token`. @@ -56,16 +64,17 @@ module FinchAPI params( access_token: String, account_id: String, - client_type: FinchAPI::Models::CreateAccessTokenResponse::ClientType::OrSymbol, + client_type: + FinchAPI::CreateAccessTokenResponse::ClientType::OrSymbol, company_id: String, connection_id: String, - connection_type: FinchAPI::Models::CreateAccessTokenResponse::ConnectionType::OrSymbol, + connection_type: + FinchAPI::CreateAccessTokenResponse::ConnectionType::OrSymbol, products: T::Array[String], provider_id: String, customer_id: T.nilable(String), token_type: String - ) - .returns(T.attached_class) + ).returns(T.attached_class) end def self.new( # The access token for the connection. @@ -94,39 +103,65 @@ module FinchAPI customer_id: nil, # The RFC 8693 token type (Finch uses `bearer` tokens) token_type: nil - ); end + ) + end + sig do - override - .returns( - { - access_token: String, - account_id: String, - client_type: FinchAPI::Models::CreateAccessTokenResponse::ClientType::TaggedSymbol, - company_id: String, - connection_id: String, - connection_type: FinchAPI::Models::CreateAccessTokenResponse::ConnectionType::TaggedSymbol, - products: T::Array[String], - provider_id: String, - customer_id: T.nilable(String), - token_type: String - } - ) + override.returns( + { + access_token: String, + account_id: String, + client_type: + FinchAPI::CreateAccessTokenResponse::ClientType::TaggedSymbol, + company_id: String, + connection_id: String, + connection_type: + FinchAPI::CreateAccessTokenResponse::ConnectionType::TaggedSymbol, + products: T::Array[String], + provider_id: String, + customer_id: T.nilable(String), + token_type: String + } + ) + end + def to_hash end - def to_hash; end # The type of application associated with a token. module ClientType extend FinchAPI::Internal::Type::Enum - TaggedSymbol = T.type_alias { T.all(Symbol, FinchAPI::Models::CreateAccessTokenResponse::ClientType) } + TaggedSymbol = + T.type_alias do + T.all(Symbol, FinchAPI::CreateAccessTokenResponse::ClientType) + end OrSymbol = T.type_alias { T.any(Symbol, String) } - 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) + PRODUCTION = + T.let( + :production, + FinchAPI::CreateAccessTokenResponse::ClientType::TaggedSymbol + ) + DEVELOPMENT = + T.let( + :development, + FinchAPI::CreateAccessTokenResponse::ClientType::TaggedSymbol + ) + SANDBOX = + T.let( + :sandbox, + FinchAPI::CreateAccessTokenResponse::ClientType::TaggedSymbol + ) - sig { override.returns(T::Array[FinchAPI::Models::CreateAccessTokenResponse::ClientType::TaggedSymbol]) } - def self.values; end + sig do + override.returns( + T::Array[ + FinchAPI::CreateAccessTokenResponse::ClientType::TaggedSymbol + ] + ) + end + def self.values + end end # The type of the connection associated with the token. @@ -137,14 +172,31 @@ module FinchAPI extend FinchAPI::Internal::Type::Enum TaggedSymbol = - T.type_alias { T.all(Symbol, FinchAPI::Models::CreateAccessTokenResponse::ConnectionType) } + T.type_alias do + T.all(Symbol, FinchAPI::CreateAccessTokenResponse::ConnectionType) + end OrSymbol = T.type_alias { T.any(Symbol, String) } - PROVIDER = T.let(:provider, FinchAPI::Models::CreateAccessTokenResponse::ConnectionType::TaggedSymbol) - FINCH = T.let(:finch, FinchAPI::Models::CreateAccessTokenResponse::ConnectionType::TaggedSymbol) + PROVIDER = + T.let( + :provider, + FinchAPI::CreateAccessTokenResponse::ConnectionType::TaggedSymbol + ) + FINCH = + T.let( + :finch, + FinchAPI::CreateAccessTokenResponse::ConnectionType::TaggedSymbol + ) - sig { override.returns(T::Array[FinchAPI::Models::CreateAccessTokenResponse::ConnectionType::TaggedSymbol]) } - def self.values; end + sig do + override.returns( + T::Array[ + FinchAPI::CreateAccessTokenResponse::ConnectionType::TaggedSymbol + ] + ) + end + def self.values + end end end end diff --git a/rbi/finch_api/models/directory_event.rbi b/rbi/finch_api/models/directory_event.rbi index dc1aeb79..1b9c418b 100644 --- a/rbi/finch_api/models/directory_event.rbi +++ b/rbi/finch_api/models/directory_event.rbi @@ -3,39 +3,48 @@ module FinchAPI module Models class DirectoryEvent < FinchAPI::Models::BaseWebhookEvent - sig { returns(T.nilable(FinchAPI::Models::DirectoryEvent::Data)) } + OrHash = T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + + sig { returns(T.nilable(FinchAPI::DirectoryEvent::Data)) } attr_reader :data - sig { params(data: T.any(FinchAPI::Models::DirectoryEvent::Data, FinchAPI::Internal::AnyHash)).void } + sig { params(data: FinchAPI::DirectoryEvent::Data::OrHash).void } attr_writer :data - sig { returns(T.nilable(FinchAPI::Models::DirectoryEvent::EventType::TaggedSymbol)) } + sig do + returns(T.nilable(FinchAPI::DirectoryEvent::EventType::TaggedSymbol)) + end attr_reader :event_type - sig { params(event_type: FinchAPI::Models::DirectoryEvent::EventType::OrSymbol).void } + sig do + params(event_type: FinchAPI::DirectoryEvent::EventType::OrSymbol).void + end attr_writer :event_type sig do params( - data: T.any(FinchAPI::Models::DirectoryEvent::Data, FinchAPI::Internal::AnyHash), - event_type: FinchAPI::Models::DirectoryEvent::EventType::OrSymbol - ) - .returns(T.attached_class) + data: FinchAPI::DirectoryEvent::Data::OrHash, + event_type: FinchAPI::DirectoryEvent::EventType::OrSymbol + ).returns(T.attached_class) + end + def self.new(data: nil, event_type: nil) end - def self.new(data: nil, event_type: nil); end sig do - override - .returns( - { - data: FinchAPI::Models::DirectoryEvent::Data, - event_type: FinchAPI::Models::DirectoryEvent::EventType::TaggedSymbol - } - ) + override.returns( + { + data: FinchAPI::DirectoryEvent::Data, + event_type: FinchAPI::DirectoryEvent::EventType::TaggedSymbol + } + ) + end + def to_hash end - def to_hash; end class Data < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + # The ID of the individual related to the event. sig { returns(T.nilable(String)) } attr_reader :individual_id @@ -47,26 +56,44 @@ module FinchAPI def self.new( # The ID of the individual related to the event. individual_id: nil - ); end - sig { override.returns({individual_id: String}) } - def to_hash; end + ) + end + + sig { override.returns({ individual_id: String }) } + def to_hash + end end module EventType extend FinchAPI::Internal::Type::Enum - TaggedSymbol = T.type_alias { T.all(Symbol, FinchAPI::Models::DirectoryEvent::EventType) } + TaggedSymbol = + T.type_alias { T.all(Symbol, FinchAPI::DirectoryEvent::EventType) } OrSymbol = T.type_alias { T.any(Symbol, String) } DIRECTORY_CREATED = - T.let(:"directory.created", FinchAPI::Models::DirectoryEvent::EventType::TaggedSymbol) + T.let( + :"directory.created", + FinchAPI::DirectoryEvent::EventType::TaggedSymbol + ) DIRECTORY_UPDATED = - T.let(:"directory.updated", FinchAPI::Models::DirectoryEvent::EventType::TaggedSymbol) + T.let( + :"directory.updated", + FinchAPI::DirectoryEvent::EventType::TaggedSymbol + ) DIRECTORY_DELETED = - T.let(:"directory.deleted", FinchAPI::Models::DirectoryEvent::EventType::TaggedSymbol) + T.let( + :"directory.deleted", + FinchAPI::DirectoryEvent::EventType::TaggedSymbol + ) - sig { override.returns(T::Array[FinchAPI::Models::DirectoryEvent::EventType::TaggedSymbol]) } - def self.values; end + sig do + override.returns( + T::Array[FinchAPI::DirectoryEvent::EventType::TaggedSymbol] + ) + end + def self.values + end end end end diff --git a/rbi/finch_api/models/disconnect_response.rbi b/rbi/finch_api/models/disconnect_response.rbi index 06dbcaa2..a4599d09 100644 --- a/rbi/finch_api/models/disconnect_response.rbi +++ b/rbi/finch_api/models/disconnect_response.rbi @@ -3,6 +3,8 @@ module FinchAPI module Models class DisconnectResponse < FinchAPI::Internal::Type::BaseModel + OrHash = T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + # If the request is successful, Finch will return “success” (HTTP 200 status). sig { returns(String) } attr_accessor :status @@ -11,9 +13,12 @@ module FinchAPI def self.new( # If the request is successful, Finch will return “success” (HTTP 200 status). status: - ); end - sig { override.returns({status: String}) } - def to_hash; end + ) + end + + sig { override.returns({ status: String }) } + def to_hash + end end end end diff --git a/rbi/finch_api/models/employment_event.rbi b/rbi/finch_api/models/employment_event.rbi index fceadeca..67f0b439 100644 --- a/rbi/finch_api/models/employment_event.rbi +++ b/rbi/finch_api/models/employment_event.rbi @@ -3,39 +3,48 @@ module FinchAPI module Models class EmploymentEvent < FinchAPI::Models::BaseWebhookEvent - sig { returns(T.nilable(FinchAPI::Models::EmploymentEvent::Data)) } + OrHash = T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + + sig { returns(T.nilable(FinchAPI::EmploymentEvent::Data)) } attr_reader :data - sig { params(data: T.any(FinchAPI::Models::EmploymentEvent::Data, FinchAPI::Internal::AnyHash)).void } + sig { params(data: FinchAPI::EmploymentEvent::Data::OrHash).void } attr_writer :data - sig { returns(T.nilable(FinchAPI::Models::EmploymentEvent::EventType::TaggedSymbol)) } + sig do + returns(T.nilable(FinchAPI::EmploymentEvent::EventType::TaggedSymbol)) + end attr_reader :event_type - sig { params(event_type: FinchAPI::Models::EmploymentEvent::EventType::OrSymbol).void } + sig do + params(event_type: FinchAPI::EmploymentEvent::EventType::OrSymbol).void + end attr_writer :event_type sig do params( - data: T.any(FinchAPI::Models::EmploymentEvent::Data, FinchAPI::Internal::AnyHash), - event_type: FinchAPI::Models::EmploymentEvent::EventType::OrSymbol - ) - .returns(T.attached_class) + data: FinchAPI::EmploymentEvent::Data::OrHash, + event_type: FinchAPI::EmploymentEvent::EventType::OrSymbol + ).returns(T.attached_class) + end + def self.new(data: nil, event_type: nil) end - def self.new(data: nil, event_type: nil); end sig do - override - .returns( - { - data: FinchAPI::Models::EmploymentEvent::Data, - event_type: FinchAPI::Models::EmploymentEvent::EventType::TaggedSymbol - } - ) + override.returns( + { + data: FinchAPI::EmploymentEvent::Data, + event_type: FinchAPI::EmploymentEvent::EventType::TaggedSymbol + } + ) + end + def to_hash end - def to_hash; end class Data < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + # The ID of the individual related to the event. sig { returns(T.nilable(String)) } attr_reader :individual_id @@ -47,26 +56,44 @@ module FinchAPI def self.new( # The ID of the individual related to the event. individual_id: nil - ); end - sig { override.returns({individual_id: String}) } - def to_hash; end + ) + end + + sig { override.returns({ individual_id: String }) } + def to_hash + end end module EventType extend FinchAPI::Internal::Type::Enum - TaggedSymbol = T.type_alias { T.all(Symbol, FinchAPI::Models::EmploymentEvent::EventType) } + TaggedSymbol = + T.type_alias { T.all(Symbol, FinchAPI::EmploymentEvent::EventType) } OrSymbol = T.type_alias { T.any(Symbol, String) } EMPLOYMENT_CREATED = - T.let(:"employment.created", FinchAPI::Models::EmploymentEvent::EventType::TaggedSymbol) + T.let( + :"employment.created", + FinchAPI::EmploymentEvent::EventType::TaggedSymbol + ) EMPLOYMENT_UPDATED = - T.let(:"employment.updated", FinchAPI::Models::EmploymentEvent::EventType::TaggedSymbol) + T.let( + :"employment.updated", + FinchAPI::EmploymentEvent::EventType::TaggedSymbol + ) EMPLOYMENT_DELETED = - T.let(:"employment.deleted", FinchAPI::Models::EmploymentEvent::EventType::TaggedSymbol) + T.let( + :"employment.deleted", + FinchAPI::EmploymentEvent::EventType::TaggedSymbol + ) - sig { override.returns(T::Array[FinchAPI::Models::EmploymentEvent::EventType::TaggedSymbol]) } - def self.values; end + sig do + override.returns( + T::Array[FinchAPI::EmploymentEvent::EventType::TaggedSymbol] + ) + end + def self.values + end end end end diff --git a/rbi/finch_api/models/hris/benefit_contribution.rbi b/rbi/finch_api/models/hris/benefit_contribution.rbi index 24236d19..4dc7d980 100644 --- a/rbi/finch_api/models/hris/benefit_contribution.rbi +++ b/rbi/finch_api/models/hris/benefit_contribution.rbi @@ -4,47 +4,77 @@ module FinchAPI module Models module HRIS class BenefitContribution < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + # Contribution amount in cents (if `fixed`) or basis points (if `percent`). sig { returns(T.nilable(Integer)) } attr_accessor :amount # Contribution type. - sig { returns(T.nilable(FinchAPI::Models::HRIS::BenefitContribution::Type::TaggedSymbol)) } + sig do + returns( + T.nilable(FinchAPI::HRIS::BenefitContribution::Type::TaggedSymbol) + ) + end attr_accessor :type sig do params( amount: T.nilable(Integer), - type: T.nilable(FinchAPI::Models::HRIS::BenefitContribution::Type::OrSymbol) - ) - .returns(T.attached_class) + type: T.nilable(FinchAPI::HRIS::BenefitContribution::Type::OrSymbol) + ).returns(T.attached_class) end def self.new( # Contribution amount in cents (if `fixed`) or basis points (if `percent`). amount: nil, # Contribution type. type: nil - ); end + ) + end + sig do - override - .returns( - {amount: T.nilable(Integer), type: T.nilable(FinchAPI::Models::HRIS::BenefitContribution::Type::TaggedSymbol)} - ) + override.returns( + { + amount: T.nilable(Integer), + type: + T.nilable( + FinchAPI::HRIS::BenefitContribution::Type::TaggedSymbol + ) + } + ) + end + def to_hash end - def to_hash; end # Contribution type. module Type extend FinchAPI::Internal::Type::Enum - TaggedSymbol = T.type_alias { T.all(Symbol, FinchAPI::Models::HRIS::BenefitContribution::Type) } + TaggedSymbol = + T.type_alias do + T.all(Symbol, FinchAPI::HRIS::BenefitContribution::Type) + end OrSymbol = T.type_alias { T.any(Symbol, String) } - FIXED = T.let(:fixed, FinchAPI::Models::HRIS::BenefitContribution::Type::TaggedSymbol) - PERCENT = T.let(:percent, FinchAPI::Models::HRIS::BenefitContribution::Type::TaggedSymbol) + FIXED = + T.let( + :fixed, + FinchAPI::HRIS::BenefitContribution::Type::TaggedSymbol + ) + PERCENT = + T.let( + :percent, + FinchAPI::HRIS::BenefitContribution::Type::TaggedSymbol + ) - sig { override.returns(T::Array[FinchAPI::Models::HRIS::BenefitContribution::Type::TaggedSymbol]) } - def self.values; end + sig do + override.returns( + T::Array[FinchAPI::HRIS::BenefitContribution::Type::TaggedSymbol] + ) + end + def self.values + end end end end diff --git a/rbi/finch_api/models/hris/benefit_create_params.rbi b/rbi/finch_api/models/hris/benefit_create_params.rbi index c531d7f0..cb20450b 100644 --- a/rbi/finch_api/models/hris/benefit_create_params.rbi +++ b/rbi/finch_api/models/hris/benefit_create_params.rbi @@ -7,17 +7,24 @@ module FinchAPI extend FinchAPI::Internal::Type::RequestParameters::Converter include FinchAPI::Internal::Type::RequestParameters + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + # The company match for this benefit. - sig { returns(T.nilable(FinchAPI::Models::HRIS::BenefitCreateParams::CompanyContribution)) } + sig do + returns( + T.nilable(FinchAPI::HRIS::BenefitCreateParams::CompanyContribution) + ) + end attr_reader :company_contribution sig do params( - company_contribution: T.nilable( - T.any(FinchAPI::Models::HRIS::BenefitCreateParams::CompanyContribution, FinchAPI::Internal::AnyHash) - ) - ) - .void + company_contribution: + T.nilable( + FinchAPI::HRIS::BenefitCreateParams::CompanyContribution::OrHash + ) + ).void end attr_writer :company_contribution @@ -31,24 +38,24 @@ module FinchAPI attr_writer :description # The frequency of the benefit deduction/contribution. - sig { returns(T.nilable(FinchAPI::Models::HRIS::BenefitFrequency::OrSymbol)) } + sig { returns(T.nilable(FinchAPI::HRIS::BenefitFrequency::OrSymbol)) } attr_accessor :frequency # Type of benefit. - sig { returns(T.nilable(FinchAPI::Models::HRIS::BenefitType::OrSymbol)) } + sig { returns(T.nilable(FinchAPI::HRIS::BenefitType::OrSymbol)) } attr_accessor :type sig do params( - company_contribution: T.nilable( - T.any(FinchAPI::Models::HRIS::BenefitCreateParams::CompanyContribution, FinchAPI::Internal::AnyHash) - ), + company_contribution: + T.nilable( + FinchAPI::HRIS::BenefitCreateParams::CompanyContribution::OrHash + ), description: String, - frequency: T.nilable(FinchAPI::Models::HRIS::BenefitFrequency::OrSymbol), - type: T.nilable(FinchAPI::Models::HRIS::BenefitType::OrSymbol), - request_options: T.any(FinchAPI::RequestOptions, FinchAPI::Internal::AnyHash) - ) - .returns(T.attached_class) + frequency: T.nilable(FinchAPI::HRIS::BenefitFrequency::OrSymbol), + type: T.nilable(FinchAPI::HRIS::BenefitType::OrSymbol), + request_options: FinchAPI::RequestOptions::OrHash + ).returns(T.attached_class) end def self.new( # The company match for this benefit. @@ -62,61 +69,101 @@ module FinchAPI # Type of benefit. type: nil, request_options: {} - ); end + ) + end + sig do - override - .returns( - { - company_contribution: T.nilable(FinchAPI::Models::HRIS::BenefitCreateParams::CompanyContribution), - description: String, - frequency: T.nilable(FinchAPI::Models::HRIS::BenefitFrequency::OrSymbol), - type: T.nilable(FinchAPI::Models::HRIS::BenefitType::OrSymbol), - request_options: FinchAPI::RequestOptions - } - ) + override.returns( + { + company_contribution: + T.nilable( + FinchAPI::HRIS::BenefitCreateParams::CompanyContribution + ), + description: String, + frequency: T.nilable(FinchAPI::HRIS::BenefitFrequency::OrSymbol), + type: T.nilable(FinchAPI::HRIS::BenefitType::OrSymbol), + request_options: FinchAPI::RequestOptions + } + ) + end + def to_hash end - def to_hash; end class CompanyContribution < FinchAPI::Internal::Type::BaseModel - sig { returns(T.nilable(T::Array[FinchAPI::Models::HRIS::BenefitCreateParams::CompanyContribution::Tier])) } + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + + sig do + returns( + T.nilable( + T::Array[ + FinchAPI::HRIS::BenefitCreateParams::CompanyContribution::Tier + ] + ) + ) + end attr_reader :tiers sig do params( - tiers: T::Array[T.any(FinchAPI::Models::HRIS::BenefitCreateParams::CompanyContribution::Tier, FinchAPI::Internal::AnyHash)] - ) - .void + tiers: + T::Array[ + FinchAPI::HRIS::BenefitCreateParams::CompanyContribution::Tier::OrHash + ] + ).void end attr_writer :tiers - sig { returns(T.nilable(FinchAPI::Models::HRIS::BenefitCreateParams::CompanyContribution::Type::OrSymbol)) } + sig do + returns( + T.nilable( + FinchAPI::HRIS::BenefitCreateParams::CompanyContribution::Type::OrSymbol + ) + ) + end attr_reader :type - sig { params(type: FinchAPI::Models::HRIS::BenefitCreateParams::CompanyContribution::Type::OrSymbol).void } + sig do + params( + type: + FinchAPI::HRIS::BenefitCreateParams::CompanyContribution::Type::OrSymbol + ).void + end attr_writer :type # The company match for this benefit. sig do params( - tiers: T::Array[T.any(FinchAPI::Models::HRIS::BenefitCreateParams::CompanyContribution::Tier, FinchAPI::Internal::AnyHash)], - type: FinchAPI::Models::HRIS::BenefitCreateParams::CompanyContribution::Type::OrSymbol - ) - .returns(T.attached_class) + tiers: + T::Array[ + FinchAPI::HRIS::BenefitCreateParams::CompanyContribution::Tier::OrHash + ], + type: + FinchAPI::HRIS::BenefitCreateParams::CompanyContribution::Type::OrSymbol + ).returns(T.attached_class) + end + def self.new(tiers: nil, type: nil) end - def self.new(tiers: nil, type: nil); end sig do - override - .returns( - { - tiers: T::Array[FinchAPI::Models::HRIS::BenefitCreateParams::CompanyContribution::Tier], - type: FinchAPI::Models::HRIS::BenefitCreateParams::CompanyContribution::Type::OrSymbol - } - ) + override.returns( + { + tiers: + T::Array[ + FinchAPI::HRIS::BenefitCreateParams::CompanyContribution::Tier + ], + type: + FinchAPI::HRIS::BenefitCreateParams::CompanyContribution::Type::OrSymbol + } + ) + end + def to_hash end - def to_hash; end class Tier < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + sig { returns(T.nilable(Integer)) } attr_reader :match @@ -129,28 +176,46 @@ module FinchAPI sig { params(threshold: Integer).void } attr_writer :threshold - sig { params(match: Integer, threshold: Integer).returns(T.attached_class) } - def self.new(match: nil, threshold: nil); end + sig do + params(match: Integer, threshold: Integer).returns( + T.attached_class + ) + end + def self.new(match: nil, threshold: nil) + end - sig { override.returns({match: Integer, threshold: Integer}) } - def to_hash; end + sig { override.returns({ match: Integer, threshold: Integer }) } + def to_hash + end end module Type extend FinchAPI::Internal::Type::Enum TaggedSymbol = - T.type_alias { T.all(Symbol, FinchAPI::Models::HRIS::BenefitCreateParams::CompanyContribution::Type) } + T.type_alias do + T.all( + Symbol, + FinchAPI::HRIS::BenefitCreateParams::CompanyContribution::Type + ) + end OrSymbol = T.type_alias { T.any(Symbol, String) } MATCH = - T.let(:match, FinchAPI::Models::HRIS::BenefitCreateParams::CompanyContribution::Type::TaggedSymbol) + T.let( + :match, + FinchAPI::HRIS::BenefitCreateParams::CompanyContribution::Type::TaggedSymbol + ) sig do - override - .returns(T::Array[FinchAPI::Models::HRIS::BenefitCreateParams::CompanyContribution::Type::TaggedSymbol]) + override.returns( + T::Array[ + FinchAPI::HRIS::BenefitCreateParams::CompanyContribution::Type::TaggedSymbol + ] + ) + end + def self.values end - def self.values; end end end end diff --git a/rbi/finch_api/models/hris/benefit_features_and_operations.rbi b/rbi/finch_api/models/hris/benefit_features_and_operations.rbi index 9b95d085..9917010f 100644 --- a/rbi/finch_api/models/hris/benefit_features_and_operations.rbi +++ b/rbi/finch_api/models/hris/benefit_features_and_operations.rbi @@ -4,55 +4,62 @@ module FinchAPI module Models module HRIS class BenefitFeaturesAndOperations < FinchAPI::Internal::Type::BaseModel - sig { returns(T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures)) } - attr_reader :supported_features + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } sig do - params( - supported_features: T.any( - FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures, - FinchAPI::Internal::AnyHash + returns( + T.nilable( + FinchAPI::HRIS::BenefitFeaturesAndOperations::SupportedFeatures ) ) - .void + end + attr_reader :supported_features + + sig do + params( + supported_features: + FinchAPI::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::OrHash + ).void end attr_writer :supported_features - sig { returns(T.nilable(FinchAPI::Models::HRIS::SupportPerBenefitType)) } + sig { returns(T.nilable(FinchAPI::HRIS::SupportPerBenefitType)) } attr_reader :supported_operations sig do params( - supported_operations: T.any(FinchAPI::Models::HRIS::SupportPerBenefitType, FinchAPI::Internal::AnyHash) - ) - .void + supported_operations: FinchAPI::HRIS::SupportPerBenefitType::OrHash + ).void end attr_writer :supported_operations sig do params( - supported_features: T.any( - FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures, - FinchAPI::Internal::AnyHash - ), - supported_operations: T.any(FinchAPI::Models::HRIS::SupportPerBenefitType, FinchAPI::Internal::AnyHash) - ) - .returns(T.attached_class) + supported_features: + FinchAPI::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::OrHash, + supported_operations: FinchAPI::HRIS::SupportPerBenefitType::OrHash + ).returns(T.attached_class) + end + def self.new(supported_features: nil, supported_operations: nil) end - def self.new(supported_features: nil, supported_operations: nil); end sig do - override - .returns( - { - supported_features: FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures, - supported_operations: FinchAPI::Models::HRIS::SupportPerBenefitType - } - ) + override.returns( + { + supported_features: + FinchAPI::HRIS::BenefitFeaturesAndOperations::SupportedFeatures, + supported_operations: FinchAPI::HRIS::SupportPerBenefitType + } + ) + end + def to_hash end - def to_hash; end class SupportedFeatures < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + # Whether the provider supports an annual maximum for this benefit. sig { returns(T.nilable(T::Boolean)) } attr_accessor :annual_maximum @@ -69,7 +76,7 @@ module FinchAPI T.nilable( T::Array[ T.nilable( - FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::CompanyContribution::TaggedSymbol + FinchAPI::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::CompanyContribution::TaggedSymbol ) ] ) @@ -87,7 +94,7 @@ module FinchAPI T.nilable( T::Array[ T.nilable( - FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::EmployeeDeduction::TaggedSymbol + FinchAPI::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::EmployeeDeduction::TaggedSymbol ) ] ) @@ -96,10 +103,23 @@ module FinchAPI 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)])) } + sig do + returns( + T.nilable( + T::Array[ + T.nilable(FinchAPI::HRIS::BenefitFrequency::TaggedSymbol) + ] + ) + ) + end attr_reader :frequencies - sig { params(frequencies: T::Array[T.nilable(FinchAPI::Models::HRIS::BenefitFrequency::OrSymbol)]).void } + sig do + params( + frequencies: + T::Array[T.nilable(FinchAPI::HRIS::BenefitFrequency::OrSymbol)] + ).void + end attr_writer :frequencies # Whether the provider supports HSA contribution limits. Empty if this feature is @@ -109,7 +129,7 @@ module FinchAPI T.nilable( T::Array[ T.nilable( - FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::HsaContributionLimit::TaggedSymbol + FinchAPI::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::HsaContributionLimit::TaggedSymbol ) ] ) @@ -121,31 +141,34 @@ 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::BenefitFeaturesAndOperations::SupportedFeatures::CompanyContribution::OrSymbol - ) - ] - ), + company_contribution: + T.nilable( + T::Array[ + T.nilable( + FinchAPI::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::CompanyContribution::OrSymbol + ) + ] + ), description: T.nilable(String), - employee_deduction: T.nilable( - T::Array[ - T.nilable( - FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::EmployeeDeduction::OrSymbol - ) - ] - ), - 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::OrSymbol - ) - ] - ) - ) - .returns(T.attached_class) + employee_deduction: + T.nilable( + T::Array[ + T.nilable( + FinchAPI::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::EmployeeDeduction::OrSymbol + ) + ] + ), + frequencies: + T::Array[T.nilable(FinchAPI::HRIS::BenefitFrequency::OrSymbol)], + hsa_contribution_limit: + T.nilable( + T::Array[ + T.nilable( + FinchAPI::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::HsaContributionLimit::OrSymbol + ) + ] + ) + ).returns(T.attached_class) end def self.new( # Whether the provider supports an annual maximum for this benefit. @@ -165,95 +188,115 @@ module FinchAPI # 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. hsa_contribution_limit: nil - ); end + ) + end + sig do - override - .returns( - { - annual_maximum: T.nilable(T::Boolean), - catch_up: T.nilable(T::Boolean), - company_contribution: T.nilable( + override.returns( + { + annual_maximum: T.nilable(T::Boolean), + catch_up: T.nilable(T::Boolean), + company_contribution: + T.nilable( T::Array[ T.nilable( - FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::CompanyContribution::TaggedSymbol + FinchAPI::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::CompanyContribution::TaggedSymbol ) ] ), - description: T.nilable(String), - employee_deduction: T.nilable( + description: T.nilable(String), + employee_deduction: + T.nilable( T::Array[ T.nilable( - FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::EmployeeDeduction::TaggedSymbol + FinchAPI::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::EmployeeDeduction::TaggedSymbol ) ] ), - frequencies: T::Array[T.nilable(FinchAPI::Models::HRIS::BenefitFrequency::TaggedSymbol)], - hsa_contribution_limit: T.nilable( + frequencies: + T::Array[ + T.nilable(FinchAPI::HRIS::BenefitFrequency::TaggedSymbol) + ], + hsa_contribution_limit: + T.nilable( T::Array[ T.nilable( - FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::HsaContributionLimit::TaggedSymbol + FinchAPI::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::HsaContributionLimit::TaggedSymbol ) ] ) - } - ) + } + ) + end + def to_hash end - def to_hash; end module CompanyContribution extend FinchAPI::Internal::Type::Enum TaggedSymbol = T.type_alias do - T.all(Symbol, FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::CompanyContribution) + T.all( + Symbol, + FinchAPI::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::CompanyContribution + ) end OrSymbol = T.type_alias { T.any(Symbol, String) } FIXED = T.let( :fixed, - FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::CompanyContribution::TaggedSymbol + FinchAPI::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::CompanyContribution::TaggedSymbol ) PERCENT = T.let( :percent, - FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::CompanyContribution::TaggedSymbol + FinchAPI::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::CompanyContribution::TaggedSymbol ) sig do - override - .returns( - T::Array[FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::CompanyContribution::TaggedSymbol] - ) + override.returns( + T::Array[ + FinchAPI::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::CompanyContribution::TaggedSymbol + ] + ) + end + def self.values end - def self.values; end end module EmployeeDeduction extend FinchAPI::Internal::Type::Enum TaggedSymbol = - T.type_alias { T.all(Symbol, FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::EmployeeDeduction) } + T.type_alias do + T.all( + Symbol, + FinchAPI::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::EmployeeDeduction + ) + end OrSymbol = T.type_alias { T.any(Symbol, String) } FIXED = T.let( :fixed, - FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::EmployeeDeduction::TaggedSymbol + FinchAPI::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::EmployeeDeduction::TaggedSymbol ) PERCENT = T.let( :percent, - FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::EmployeeDeduction::TaggedSymbol + FinchAPI::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::EmployeeDeduction::TaggedSymbol ) sig do - override - .returns( - T::Array[FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::EmployeeDeduction::TaggedSymbol] - ) + override.returns( + T::Array[ + FinchAPI::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::EmployeeDeduction::TaggedSymbol + ] + ) + end + def self.values end - def self.values; end end module HsaContributionLimit @@ -261,30 +304,33 @@ module FinchAPI TaggedSymbol = T.type_alias do - T.all(Symbol, FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::HsaContributionLimit) + T.all( + Symbol, + FinchAPI::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::HsaContributionLimit + ) end OrSymbol = T.type_alias { T.any(Symbol, String) } INDIVIDUAL = T.let( :individual, - FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::HsaContributionLimit::TaggedSymbol + FinchAPI::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::HsaContributionLimit::TaggedSymbol ) FAMILY = T.let( :family, - FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::HsaContributionLimit::TaggedSymbol + FinchAPI::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::HsaContributionLimit::TaggedSymbol ) sig do - override - .returns( - T::Array[ - FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::HsaContributionLimit::TaggedSymbol - ] - ) + override.returns( + T::Array[ + FinchAPI::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::HsaContributionLimit::TaggedSymbol + ] + ) + end + def self.values end - def self.values; end end end end diff --git a/rbi/finch_api/models/hris/benefit_frequency.rbi b/rbi/finch_api/models/hris/benefit_frequency.rbi index 355d69c8..05caa7f6 100644 --- a/rbi/finch_api/models/hris/benefit_frequency.rbi +++ b/rbi/finch_api/models/hris/benefit_frequency.rbi @@ -7,15 +7,24 @@ module FinchAPI module BenefitFrequency extend FinchAPI::Internal::Type::Enum - TaggedSymbol = T.type_alias { T.all(Symbol, FinchAPI::Models::HRIS::BenefitFrequency) } + TaggedSymbol = + T.type_alias { T.all(Symbol, FinchAPI::HRIS::BenefitFrequency) } OrSymbol = T.type_alias { T.any(Symbol, String) } - 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) + ONE_TIME = + T.let(:one_time, FinchAPI::HRIS::BenefitFrequency::TaggedSymbol) + EVERY_PAYCHECK = + T.let(:every_paycheck, FinchAPI::HRIS::BenefitFrequency::TaggedSymbol) + MONTHLY = + T.let(:monthly, FinchAPI::HRIS::BenefitFrequency::TaggedSymbol) - sig { override.returns(T::Array[FinchAPI::Models::HRIS::BenefitFrequency::TaggedSymbol]) } - def self.values; end + sig do + override.returns( + T::Array[FinchAPI::HRIS::BenefitFrequency::TaggedSymbol] + ) + end + def self.values + end end end end diff --git a/rbi/finch_api/models/hris/benefit_list_params.rbi b/rbi/finch_api/models/hris/benefit_list_params.rbi index 841339f0..61362160 100644 --- a/rbi/finch_api/models/hris/benefit_list_params.rbi +++ b/rbi/finch_api/models/hris/benefit_list_params.rbi @@ -7,14 +7,20 @@ module FinchAPI extend FinchAPI::Internal::Type::RequestParameters::Converter include FinchAPI::Internal::Type::RequestParameters + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + sig do - params(request_options: T.any(FinchAPI::RequestOptions, FinchAPI::Internal::AnyHash)) - .returns(T.attached_class) + params(request_options: FinchAPI::RequestOptions::OrHash).returns( + T.attached_class + ) + end + def self.new(request_options: {}) end - def self.new(request_options: {}); end - sig { override.returns({request_options: FinchAPI::RequestOptions}) } - def to_hash; end + sig { override.returns({ request_options: FinchAPI::RequestOptions }) } + def to_hash + end end end end diff --git a/rbi/finch_api/models/hris/benefit_list_supported_benefits_params.rbi b/rbi/finch_api/models/hris/benefit_list_supported_benefits_params.rbi index 5c2bd591..eabf8b5c 100644 --- a/rbi/finch_api/models/hris/benefit_list_supported_benefits_params.rbi +++ b/rbi/finch_api/models/hris/benefit_list_supported_benefits_params.rbi @@ -7,14 +7,20 @@ module FinchAPI extend FinchAPI::Internal::Type::RequestParameters::Converter include FinchAPI::Internal::Type::RequestParameters + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + sig do - params(request_options: T.any(FinchAPI::RequestOptions, FinchAPI::Internal::AnyHash)) - .returns(T.attached_class) + params(request_options: FinchAPI::RequestOptions::OrHash).returns( + T.attached_class + ) + end + def self.new(request_options: {}) end - def self.new(request_options: {}); end - sig { override.returns({request_options: FinchAPI::RequestOptions}) } - def to_hash; end + sig { override.returns({ request_options: FinchAPI::RequestOptions }) } + def to_hash + end end end end diff --git a/rbi/finch_api/models/hris/benefit_list_supported_benefits_response.rbi b/rbi/finch_api/models/hris/benefit_list_supported_benefits_response.rbi index 2d5369b5..3df38f27 100644 --- a/rbi/finch_api/models/hris/benefit_list_supported_benefits_response.rbi +++ b/rbi/finch_api/models/hris/benefit_list_supported_benefits_response.rbi @@ -4,6 +4,9 @@ module FinchAPI module Models module HRIS class BenefitListSupportedBenefitsResponse < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + # Whether the provider supports an annual maximum for this benefit. sig { returns(T.nilable(T::Boolean)) } attr_accessor :annual_maximum @@ -18,7 +21,11 @@ module FinchAPI sig do returns( T.nilable( - T::Array[T.nilable(FinchAPI::Models::HRIS::BenefitListSupportedBenefitsResponse::CompanyContribution::TaggedSymbol)] + T::Array[ + T.nilable( + FinchAPI::Models::HRIS::BenefitListSupportedBenefitsResponse::CompanyContribution::TaggedSymbol + ) + ] ) ) end @@ -32,17 +39,34 @@ module FinchAPI sig do returns( T.nilable( - T::Array[T.nilable(FinchAPI::Models::HRIS::BenefitListSupportedBenefitsResponse::EmployeeDeduction::TaggedSymbol)] + T::Array[ + T.nilable( + FinchAPI::Models::HRIS::BenefitListSupportedBenefitsResponse::EmployeeDeduction::TaggedSymbol + ) + ] ) ) 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)])) } + sig do + returns( + T.nilable( + T::Array[ + T.nilable(FinchAPI::HRIS::BenefitFrequency::TaggedSymbol) + ] + ) + ) + end attr_reader :frequencies - sig { params(frequencies: T::Array[T.nilable(FinchAPI::Models::HRIS::BenefitFrequency::OrSymbol)]).void } + sig do + params( + frequencies: + T::Array[T.nilable(FinchAPI::HRIS::BenefitFrequency::OrSymbol)] + ).void + end attr_writer :frequencies # Whether the provider supports HSA contribution limits. Empty if this feature is @@ -64,19 +88,34 @@ 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::BenefitListSupportedBenefitsResponse::CompanyContribution::OrSymbol)] - ), + company_contribution: + T.nilable( + T::Array[ + T.nilable( + FinchAPI::Models::HRIS::BenefitListSupportedBenefitsResponse::CompanyContribution::OrSymbol + ) + ] + ), description: T.nilable(String), - employee_deduction: T.nilable( - T::Array[T.nilable(FinchAPI::Models::HRIS::BenefitListSupportedBenefitsResponse::EmployeeDeduction::OrSymbol)] - ), - frequencies: T::Array[T.nilable(FinchAPI::Models::HRIS::BenefitFrequency::OrSymbol)], - hsa_contribution_limit: T.nilable( - T::Array[T.nilable(FinchAPI::Models::HRIS::BenefitListSupportedBenefitsResponse::HsaContributionLimit::OrSymbol)] - ) - ) - .returns(T.attached_class) + employee_deduction: + T.nilable( + T::Array[ + T.nilable( + FinchAPI::Models::HRIS::BenefitListSupportedBenefitsResponse::EmployeeDeduction::OrSymbol + ) + ] + ), + frequencies: + T::Array[T.nilable(FinchAPI::HRIS::BenefitFrequency::OrSymbol)], + hsa_contribution_limit: + T.nilable( + T::Array[ + T.nilable( + FinchAPI::Models::HRIS::BenefitListSupportedBenefitsResponse::HsaContributionLimit::OrSymbol + ) + ] + ) + ).returns(T.attached_class) end def self.new( # Whether the provider supports an annual maximum for this benefit. @@ -96,38 +135,59 @@ module FinchAPI # 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. hsa_contribution_limit: nil - ); end + ) + end + sig do - override - .returns( - { - annual_maximum: T.nilable(T::Boolean), - catch_up: T.nilable(T::Boolean), - company_contribution: T.nilable( - T::Array[T.nilable(FinchAPI::Models::HRIS::BenefitListSupportedBenefitsResponse::CompanyContribution::TaggedSymbol)] + override.returns( + { + annual_maximum: T.nilable(T::Boolean), + catch_up: T.nilable(T::Boolean), + company_contribution: + T.nilable( + T::Array[ + T.nilable( + FinchAPI::Models::HRIS::BenefitListSupportedBenefitsResponse::CompanyContribution::TaggedSymbol + ) + ] ), - description: T.nilable(String), - employee_deduction: T.nilable( - T::Array[T.nilable(FinchAPI::Models::HRIS::BenefitListSupportedBenefitsResponse::EmployeeDeduction::TaggedSymbol)] + description: T.nilable(String), + employee_deduction: + T.nilable( + T::Array[ + T.nilable( + FinchAPI::Models::HRIS::BenefitListSupportedBenefitsResponse::EmployeeDeduction::TaggedSymbol + ) + ] ), - frequencies: T::Array[T.nilable(FinchAPI::Models::HRIS::BenefitFrequency::TaggedSymbol)], - hsa_contribution_limit: T.nilable( + frequencies: + T::Array[ + T.nilable(FinchAPI::HRIS::BenefitFrequency::TaggedSymbol) + ], + hsa_contribution_limit: + T.nilable( T::Array[ T.nilable( FinchAPI::Models::HRIS::BenefitListSupportedBenefitsResponse::HsaContributionLimit::TaggedSymbol ) ] ) - } - ) + } + ) + end + def to_hash end - def to_hash; end module CompanyContribution extend FinchAPI::Internal::Type::Enum TaggedSymbol = - T.type_alias { T.all(Symbol, FinchAPI::Models::HRIS::BenefitListSupportedBenefitsResponse::CompanyContribution) } + T.type_alias do + T.all( + Symbol, + FinchAPI::Models::HRIS::BenefitListSupportedBenefitsResponse::CompanyContribution + ) + end OrSymbol = T.type_alias { T.any(Symbol, String) } FIXED = @@ -142,19 +202,26 @@ module FinchAPI ) sig do - override - .returns( - T::Array[FinchAPI::Models::HRIS::BenefitListSupportedBenefitsResponse::CompanyContribution::TaggedSymbol] - ) + override.returns( + T::Array[ + FinchAPI::Models::HRIS::BenefitListSupportedBenefitsResponse::CompanyContribution::TaggedSymbol + ] + ) + end + def self.values end - def self.values; end end module EmployeeDeduction extend FinchAPI::Internal::Type::Enum TaggedSymbol = - T.type_alias { T.all(Symbol, FinchAPI::Models::HRIS::BenefitListSupportedBenefitsResponse::EmployeeDeduction) } + T.type_alias do + T.all( + Symbol, + FinchAPI::Models::HRIS::BenefitListSupportedBenefitsResponse::EmployeeDeduction + ) + end OrSymbol = T.type_alias { T.any(Symbol, String) } FIXED = @@ -169,19 +236,26 @@ module FinchAPI ) sig do - override - .returns( - T::Array[FinchAPI::Models::HRIS::BenefitListSupportedBenefitsResponse::EmployeeDeduction::TaggedSymbol] - ) + override.returns( + T::Array[ + FinchAPI::Models::HRIS::BenefitListSupportedBenefitsResponse::EmployeeDeduction::TaggedSymbol + ] + ) + end + def self.values end - def self.values; end end module HsaContributionLimit extend FinchAPI::Internal::Type::Enum TaggedSymbol = - T.type_alias { T.all(Symbol, FinchAPI::Models::HRIS::BenefitListSupportedBenefitsResponse::HsaContributionLimit) } + T.type_alias do + T.all( + Symbol, + FinchAPI::Models::HRIS::BenefitListSupportedBenefitsResponse::HsaContributionLimit + ) + end OrSymbol = T.type_alias { T.any(Symbol, String) } INDIVIDUAL = @@ -196,12 +270,14 @@ module FinchAPI ) sig do - override - .returns( - T::Array[FinchAPI::Models::HRIS::BenefitListSupportedBenefitsResponse::HsaContributionLimit::TaggedSymbol] - ) + override.returns( + T::Array[ + FinchAPI::Models::HRIS::BenefitListSupportedBenefitsResponse::HsaContributionLimit::TaggedSymbol + ] + ) + end + def self.values end - def self.values; end end end end diff --git a/rbi/finch_api/models/hris/benefit_retrieve_params.rbi b/rbi/finch_api/models/hris/benefit_retrieve_params.rbi index 81b57c87..a6214ebe 100644 --- a/rbi/finch_api/models/hris/benefit_retrieve_params.rbi +++ b/rbi/finch_api/models/hris/benefit_retrieve_params.rbi @@ -7,14 +7,20 @@ module FinchAPI extend FinchAPI::Internal::Type::RequestParameters::Converter include FinchAPI::Internal::Type::RequestParameters + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + sig do - params(request_options: T.any(FinchAPI::RequestOptions, FinchAPI::Internal::AnyHash)) - .returns(T.attached_class) + params(request_options: FinchAPI::RequestOptions::OrHash).returns( + T.attached_class + ) + end + def self.new(request_options: {}) end - def self.new(request_options: {}); end - sig { override.returns({request_options: FinchAPI::RequestOptions}) } - def to_hash; end + sig { override.returns({ request_options: FinchAPI::RequestOptions }) } + def to_hash + end end end end diff --git a/rbi/finch_api/models/hris/benefit_type.rbi b/rbi/finch_api/models/hris/benefit_type.rbi index 63eb8214..01e74cf6 100644 --- a/rbi/finch_api/models/hris/benefit_type.rbi +++ b/rbi/finch_api/models/hris/benefit_type.rbi @@ -7,31 +7,50 @@ module FinchAPI module BenefitType extend FinchAPI::Internal::Type::Enum - TaggedSymbol = T.type_alias { T.all(Symbol, FinchAPI::Models::HRIS::BenefitType) } + TaggedSymbol = + T.type_alias { T.all(Symbol, FinchAPI::HRIS::BenefitType) } OrSymbol = T.type_alias { T.any(Symbol, String) } - BENEFIT_TYPE_401K = T.let(:"401k", FinchAPI::Models::HRIS::BenefitType::TaggedSymbol) - BENEFIT_TYPE_401K_ROTH = T.let(:"401k_roth", FinchAPI::Models::HRIS::BenefitType::TaggedSymbol) - BENEFIT_TYPE_401K_LOAN = T.let(:"401k_loan", FinchAPI::Models::HRIS::BenefitType::TaggedSymbol) - BENEFIT_TYPE_403B = T.let(:"403b", FinchAPI::Models::HRIS::BenefitType::TaggedSymbol) - BENEFIT_TYPE_403B_ROTH = T.let(:"403b_roth", FinchAPI::Models::HRIS::BenefitType::TaggedSymbol) - BENEFIT_TYPE_457 = T.let(:"457", FinchAPI::Models::HRIS::BenefitType::TaggedSymbol) - BENEFIT_TYPE_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) + BENEFIT_TYPE_401K = + T.let(:"401k", FinchAPI::HRIS::BenefitType::TaggedSymbol) + BENEFIT_TYPE_401K_ROTH = + T.let(:"401k_roth", FinchAPI::HRIS::BenefitType::TaggedSymbol) + BENEFIT_TYPE_401K_LOAN = + T.let(:"401k_loan", FinchAPI::HRIS::BenefitType::TaggedSymbol) + BENEFIT_TYPE_403B = + T.let(:"403b", FinchAPI::HRIS::BenefitType::TaggedSymbol) + BENEFIT_TYPE_403B_ROTH = + T.let(:"403b_roth", FinchAPI::HRIS::BenefitType::TaggedSymbol) + BENEFIT_TYPE_457 = + T.let(:"457", FinchAPI::HRIS::BenefitType::TaggedSymbol) + BENEFIT_TYPE_457_ROTH = + T.let(:"457_roth", FinchAPI::HRIS::BenefitType::TaggedSymbol) + S125_MEDICAL = + T.let(:s125_medical, FinchAPI::HRIS::BenefitType::TaggedSymbol) + S125_DENTAL = + T.let(:s125_dental, FinchAPI::HRIS::BenefitType::TaggedSymbol) + S125_VISION = + T.let(:s125_vision, FinchAPI::HRIS::BenefitType::TaggedSymbol) + HSA_PRE = T.let(:hsa_pre, FinchAPI::HRIS::BenefitType::TaggedSymbol) + HSA_POST = T.let(:hsa_post, FinchAPI::HRIS::BenefitType::TaggedSymbol) + FSA_MEDICAL = + T.let(:fsa_medical, FinchAPI::HRIS::BenefitType::TaggedSymbol) + FSA_DEPENDENT_CARE = + T.let(:fsa_dependent_care, FinchAPI::HRIS::BenefitType::TaggedSymbol) + SIMPLE_IRA = + T.let(:simple_ira, FinchAPI::HRIS::BenefitType::TaggedSymbol) + SIMPLE = T.let(:simple, FinchAPI::HRIS::BenefitType::TaggedSymbol) + COMMUTER = T.let(:commuter, FinchAPI::HRIS::BenefitType::TaggedSymbol) + CUSTOM_POST_TAX = + T.let(:custom_post_tax, FinchAPI::HRIS::BenefitType::TaggedSymbol) + CUSTOM_PRE_TAX = + T.let(:custom_pre_tax, FinchAPI::HRIS::BenefitType::TaggedSymbol) - sig { override.returns(T::Array[FinchAPI::Models::HRIS::BenefitType::TaggedSymbol]) } - def self.values; end + sig do + override.returns(T::Array[FinchAPI::HRIS::BenefitType::TaggedSymbol]) + end + def self.values + end end end end diff --git a/rbi/finch_api/models/hris/benefit_update_params.rbi b/rbi/finch_api/models/hris/benefit_update_params.rbi index b194fc28..69edc451 100644 --- a/rbi/finch_api/models/hris/benefit_update_params.rbi +++ b/rbi/finch_api/models/hris/benefit_update_params.rbi @@ -7,6 +7,9 @@ module FinchAPI extend FinchAPI::Internal::Type::RequestParameters::Converter include FinchAPI::Internal::Type::RequestParameters + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + # Updated name or description. sig { returns(T.nilable(String)) } attr_reader :description @@ -17,20 +20,23 @@ module FinchAPI sig do params( description: String, - request_options: T.any( - FinchAPI::RequestOptions, - FinchAPI::Internal::AnyHash - ) - ) - .returns(T.attached_class) + request_options: FinchAPI::RequestOptions::OrHash + ).returns(T.attached_class) end def self.new( # Updated name or description. description: nil, request_options: {} - ); end - sig { override.returns({description: String, request_options: FinchAPI::RequestOptions}) } - def to_hash; end + ) + end + + sig do + override.returns( + { description: String, request_options: FinchAPI::RequestOptions } + ) + end + def to_hash + end end end end diff --git a/rbi/finch_api/models/hris/benefits/enrolled_individual_benefit_response.rbi b/rbi/finch_api/models/hris/benefits/enrolled_individual_benefit_response.rbi index 179f79fc..891239d7 100644 --- a/rbi/finch_api/models/hris/benefits/enrolled_individual_benefit_response.rbi +++ b/rbi/finch_api/models/hris/benefits/enrolled_individual_benefit_response.rbi @@ -5,14 +5,19 @@ module FinchAPI module HRIS module Benefits class EnrolledIndividualBenefitResponse < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + sig { returns(String) } attr_accessor :job_id sig { params(job_id: String).returns(T.attached_class) } - def self.new(job_id:); end + def self.new(job_id:) + end - sig { override.returns({job_id: String}) } - def to_hash; end + sig { override.returns({ job_id: String }) } + def to_hash + end end end end diff --git a/rbi/finch_api/models/hris/benefits/individual_benefit.rbi b/rbi/finch_api/models/hris/benefits/individual_benefit.rbi index 40dc160d..d8474420 100644 --- a/rbi/finch_api/models/hris/benefits/individual_benefit.rbi +++ b/rbi/finch_api/models/hris/benefits/individual_benefit.rbi @@ -3,16 +3,24 @@ module FinchAPI module Models module HRIS + IndividualBenefit = Benefits::IndividualBenefit + module Benefits class IndividualBenefit < FinchAPI::Internal::Type::BaseModel - sig { returns(T.nilable(FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body)) } + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + + sig do + returns( + T.nilable(FinchAPI::HRIS::Benefits::IndividualBenefit::Body) + ) + end attr_reader :body sig do params( - body: T.any(FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body, FinchAPI::Internal::AnyHash) - ) - .void + body: FinchAPI::HRIS::Benefits::IndividualBenefit::Body::OrHash + ).void end attr_writer :body @@ -30,23 +38,30 @@ module FinchAPI sig do params( - body: T.any(FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body, FinchAPI::Internal::AnyHash), + body: FinchAPI::HRIS::Benefits::IndividualBenefit::Body::OrHash, code: Integer, individual_id: String - ) - .returns(T.attached_class) + ).returns(T.attached_class) + end + def self.new(body: nil, code: nil, individual_id: nil) end - def self.new(body: nil, code: nil, individual_id: nil); end sig do - override - .returns( - {body: FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body, code: Integer, individual_id: String} - ) + override.returns( + { + body: FinchAPI::HRIS::Benefits::IndividualBenefit::Body, + code: Integer, + individual_id: String + } + ) + end + def to_hash end - def to_hash; end class Body < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + # If the benefit supports annual maximum, the amount in cents for this individual. sig { returns(T.nilable(Integer)) } attr_accessor :annual_maximum @@ -56,32 +71,34 @@ module FinchAPI sig { returns(T.nilable(T::Boolean)) } attr_accessor :catch_up - sig { returns(T.nilable(FinchAPI::Models::HRIS::BenefitContribution)) } + sig { returns(T.nilable(FinchAPI::HRIS::BenefitContribution)) } attr_reader :company_contribution sig do params( - company_contribution: T.nilable(T.any(FinchAPI::Models::HRIS::BenefitContribution, FinchAPI::Internal::AnyHash)) - ) - .void + company_contribution: + T.nilable(FinchAPI::HRIS::BenefitContribution::OrHash) + ).void end attr_writer :company_contribution - sig { returns(T.nilable(FinchAPI::Models::HRIS::BenefitContribution)) } + sig { returns(T.nilable(FinchAPI::HRIS::BenefitContribution)) } attr_reader :employee_deduction sig do params( - employee_deduction: T.nilable(T.any(FinchAPI::Models::HRIS::BenefitContribution, FinchAPI::Internal::AnyHash)) - ) - .void + employee_deduction: + T.nilable(FinchAPI::HRIS::BenefitContribution::OrHash) + ).void end attr_writer :employee_deduction # Type for HSA contribution limit if the benefit is a HSA. sig do returns( - T.nilable(FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::HsaContributionLimit::TaggedSymbol) + T.nilable( + FinchAPI::HRIS::Benefits::IndividualBenefit::Body::HsaContributionLimit::TaggedSymbol + ) ) end attr_accessor :hsa_contribution_limit @@ -90,11 +107,15 @@ module FinchAPI params( annual_maximum: T.nilable(Integer), catch_up: T.nilable(T::Boolean), - company_contribution: T.nilable(T.any(FinchAPI::Models::HRIS::BenefitContribution, FinchAPI::Internal::AnyHash)), - employee_deduction: T.nilable(T.any(FinchAPI::Models::HRIS::BenefitContribution, FinchAPI::Internal::AnyHash)), - hsa_contribution_limit: T.nilable(FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::HsaContributionLimit::OrSymbol) - ) - .returns(T.attached_class) + company_contribution: + T.nilable(FinchAPI::HRIS::BenefitContribution::OrHash), + employee_deduction: + T.nilable(FinchAPI::HRIS::BenefitContribution::OrHash), + hsa_contribution_limit: + T.nilable( + FinchAPI::HRIS::Benefits::IndividualBenefit::Body::HsaContributionLimit::OrSymbol + ) + ).returns(T.attached_class) end def self.new( # If the benefit supports annual maximum, the amount in cents for this individual. @@ -106,53 +127,65 @@ module FinchAPI employee_deduction: nil, # Type for HSA contribution limit if the benefit is a HSA. hsa_contribution_limit: nil - ); end + ) + end + sig do - override - .returns( - { - 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), - hsa_contribution_limit: T.nilable(FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::HsaContributionLimit::TaggedSymbol) - } - ) + override.returns( + { + annual_maximum: T.nilable(Integer), + catch_up: T.nilable(T::Boolean), + company_contribution: + T.nilable(FinchAPI::HRIS::BenefitContribution), + employee_deduction: + T.nilable(FinchAPI::HRIS::BenefitContribution), + hsa_contribution_limit: + T.nilable( + FinchAPI::HRIS::Benefits::IndividualBenefit::Body::HsaContributionLimit::TaggedSymbol + ) + } + ) + end + def to_hash end - def to_hash; end # Type for HSA contribution limit if the benefit is a HSA. module HsaContributionLimit extend FinchAPI::Internal::Type::Enum TaggedSymbol = - T.type_alias { T.all(Symbol, FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::HsaContributionLimit) } + T.type_alias do + T.all( + Symbol, + FinchAPI::HRIS::Benefits::IndividualBenefit::Body::HsaContributionLimit + ) + end OrSymbol = T.type_alias { T.any(Symbol, String) } INDIVIDUAL = T.let( :individual, - FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::HsaContributionLimit::TaggedSymbol + FinchAPI::HRIS::Benefits::IndividualBenefit::Body::HsaContributionLimit::TaggedSymbol ) FAMILY = T.let( :family, - FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::HsaContributionLimit::TaggedSymbol + FinchAPI::HRIS::Benefits::IndividualBenefit::Body::HsaContributionLimit::TaggedSymbol ) sig do - override - .returns( - T::Array[FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::HsaContributionLimit::TaggedSymbol] - ) + override.returns( + T::Array[ + FinchAPI::HRIS::Benefits::IndividualBenefit::Body::HsaContributionLimit::TaggedSymbol + ] + ) + end + def self.values end - def self.values; end end end end end - - IndividualBenefit = Benefits::IndividualBenefit end end end diff --git a/rbi/finch_api/models/hris/benefits/individual_enroll_many_params.rbi b/rbi/finch_api/models/hris/benefits/individual_enroll_many_params.rbi index 58de6361..9d56a8b2 100644 --- a/rbi/finch_api/models/hris/benefits/individual_enroll_many_params.rbi +++ b/rbi/finch_api/models/hris/benefits/individual_enroll_many_params.rbi @@ -8,67 +8,79 @@ module FinchAPI extend FinchAPI::Internal::Type::RequestParameters::Converter include FinchAPI::Internal::Type::RequestParameters + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + # Array of the individual_id to enroll and a configuration object. - sig { returns(T.nilable(T::Array[FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual])) } + sig do + returns( + T.nilable( + T::Array[ + FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual + ] + ) + ) + end attr_reader :individuals sig do params( - individuals: T::Array[ - T.any( - FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual, - FinchAPI::Internal::AnyHash - ) - ] - ) - .void + individuals: + T::Array[ + FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::OrHash + ] + ).void end attr_writer :individuals sig do params( - individuals: T::Array[ - T.any( - FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual, - FinchAPI::Internal::AnyHash - ) - ], - request_options: T.any(FinchAPI::RequestOptions, FinchAPI::Internal::AnyHash) - ) - .returns(T.attached_class) + individuals: + T::Array[ + FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::OrHash + ], + request_options: FinchAPI::RequestOptions::OrHash + ).returns(T.attached_class) end def self.new( # Array of the individual_id to enroll and a configuration object. individuals: nil, request_options: {} - ); end + ) + end + sig do - override - .returns( - { - individuals: T::Array[FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual], - request_options: FinchAPI::RequestOptions - } - ) + override.returns( + { + individuals: + T::Array[ + FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual + ], + request_options: FinchAPI::RequestOptions + } + ) + end + def to_hash end - def to_hash; end class Individual < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + sig do returns( - T.nilable(FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration) + T.nilable( + FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration + ) ) end attr_reader :configuration sig do params( - configuration: T.any( - FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration, - FinchAPI::Internal::AnyHash - ) - ) - .void + configuration: + FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::OrHash + ).void end attr_writer :configuration @@ -81,37 +93,40 @@ module FinchAPI sig do params( - configuration: T.any( - FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration, - FinchAPI::Internal::AnyHash - ), + configuration: + FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::OrHash, individual_id: String - ) - .returns(T.attached_class) + ).returns(T.attached_class) end def self.new( configuration: nil, # Finch id (uuidv4) for the individual to enroll individual_id: nil - ); end + ) + end + sig do - override - .returns( - { - configuration: FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration, - individual_id: String - } - ) + override.returns( + { + configuration: + FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration, + individual_id: String + } + ) + end + def to_hash end - def to_hash; end class Configuration < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + # For HSA benefits only - whether the contribution limit is for an individual or # family sig do returns( T.nilable( - FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::AnnualContributionLimit::OrSymbol + FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::AnnualContributionLimit::OrSymbol ) ) end @@ -119,9 +134,9 @@ module FinchAPI sig do params( - annual_contribution_limit: FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::AnnualContributionLimit::OrSymbol - ) - .void + annual_contribution_limit: + FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::AnnualContributionLimit::OrSymbol + ).void end attr_writer :annual_contribution_limit @@ -139,7 +154,7 @@ module FinchAPI sig do returns( T.nilable( - FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution + FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution ) ) end @@ -147,12 +162,9 @@ module FinchAPI sig do params( - company_contribution: T.any( - FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution, - FinchAPI::Internal::AnyHash - ) - ) - .void + company_contribution: + FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution::OrHash + ).void end attr_writer :company_contribution @@ -166,7 +178,7 @@ module FinchAPI sig do returns( T.nilable( - FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction + FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction ) ) end @@ -174,31 +186,24 @@ module FinchAPI sig do params( - employee_deduction: T.any( - FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction, - FinchAPI::Internal::AnyHash - ) - ) - .void + employee_deduction: + FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction::OrHash + ).void end attr_writer :employee_deduction sig do params( - annual_contribution_limit: FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::AnnualContributionLimit::OrSymbol, + annual_contribution_limit: + FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::AnnualContributionLimit::OrSymbol, annual_maximum: T.nilable(Integer), catch_up: T::Boolean, - company_contribution: T.any( - FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution, - FinchAPI::Internal::AnyHash - ), + company_contribution: + FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution::OrHash, effective_date: Date, - employee_deduction: T.any( - FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction, - FinchAPI::Internal::AnyHash - ) - ) - .returns(T.attached_class) + employee_deduction: + FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction::OrHash + ).returns(T.attached_class) end def self.new( # For HSA benefits only - whether the contribution limit is for an individual or @@ -212,21 +217,26 @@ module FinchAPI # The date the enrollment will take effect effective_date: nil, employee_deduction: nil - ); end + ) + end + sig do - override - .returns( - { - 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, - effective_date: Date, - employee_deduction: FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction - } - ) + override.returns( + { + annual_contribution_limit: + FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::AnnualContributionLimit::OrSymbol, + annual_maximum: T.nilable(Integer), + catch_up: T::Boolean, + company_contribution: + FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution, + effective_date: Date, + employee_deduction: + FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction + } + ) + end + def to_hash end - def to_hash; end # For HSA benefits only - whether the contribution limit is for an individual or # family @@ -235,33 +245,41 @@ module FinchAPI TaggedSymbol = T.type_alias do - T.all(Symbol, FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::AnnualContributionLimit) + T.all( + Symbol, + FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::AnnualContributionLimit + ) end OrSymbol = T.type_alias { T.any(Symbol, String) } INDIVIDUAL = T.let( :individual, - FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::AnnualContributionLimit::TaggedSymbol + FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::AnnualContributionLimit::TaggedSymbol ) FAMILY = T.let( :family, - FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::AnnualContributionLimit::TaggedSymbol + FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::AnnualContributionLimit::TaggedSymbol ) sig do - override - .returns( - T::Array[ - FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::AnnualContributionLimit::TaggedSymbol - ] - ) + override.returns( + T::Array[ + FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::AnnualContributionLimit::TaggedSymbol + ] + ) + end + def self.values end - def self.values; end end class CompanyContribution < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any(T.self_type, FinchAPI::Internal::AnyHash) + end + # Amount in cents for fixed type or basis points (1/100th of a percent) for # percent type sig { returns(T.nilable(Integer)) } @@ -273,7 +291,7 @@ module FinchAPI sig do returns( T.nilable( - FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution::Type::OrSymbol + FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution::Type::OrSymbol ) ) end @@ -281,69 +299,80 @@ module FinchAPI sig do params( - type: FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution::Type::OrSymbol - ) - .void + type: + FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution::Type::OrSymbol + ).void end attr_writer :type sig do params( amount: Integer, - type: FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution::Type::OrSymbol - ) - .returns(T.attached_class) + type: + FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution::Type::OrSymbol + ).returns(T.attached_class) end def self.new( # Amount in cents for fixed type or basis points (1/100th of a percent) for # percent type amount: nil, type: nil - ); end + ) + end + sig do - override - .returns( - { - amount: Integer, - type: FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution::Type::OrSymbol - } - ) + override.returns( + { + amount: Integer, + type: + FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution::Type::OrSymbol + } + ) + end + def to_hash end - def to_hash; end module Type extend FinchAPI::Internal::Type::Enum TaggedSymbol = T.type_alias do - T.all(Symbol, FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution::Type) + T.all( + Symbol, + FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution::Type + ) end OrSymbol = T.type_alias { T.any(Symbol, String) } FIXED = T.let( :fixed, - FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution::Type::TaggedSymbol + FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution::Type::TaggedSymbol ) PERCENT = T.let( :percent, - FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution::Type::TaggedSymbol + FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution::Type::TaggedSymbol ) sig do - override - .returns( - T::Array[ - FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution::Type::TaggedSymbol - ] - ) + override.returns( + T::Array[ + FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution::Type::TaggedSymbol + ] + ) + end + def self.values end - def self.values; end end end class EmployeeDeduction < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any(T.self_type, FinchAPI::Internal::AnyHash) + end + # Amount in cents for fixed type or basis points (1/100th of a percent) for # percent type sig { returns(T.nilable(Integer)) } @@ -355,7 +384,7 @@ module FinchAPI sig do returns( T.nilable( - FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction::Type::OrSymbol + FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction::Type::OrSymbol ) ) end @@ -363,65 +392,71 @@ module FinchAPI sig do params( - type: FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction::Type::OrSymbol - ) - .void + type: + FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction::Type::OrSymbol + ).void end attr_writer :type sig do params( amount: Integer, - type: FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction::Type::OrSymbol - ) - .returns(T.attached_class) + type: + FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction::Type::OrSymbol + ).returns(T.attached_class) end def self.new( # Amount in cents for fixed type or basis points (1/100th of a percent) for # percent type amount: nil, type: nil - ); end + ) + end + sig do - override - .returns( - { - amount: Integer, - type: FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction::Type::OrSymbol - } - ) + override.returns( + { + amount: Integer, + type: + FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction::Type::OrSymbol + } + ) + end + def to_hash end - def to_hash; end module Type extend FinchAPI::Internal::Type::Enum TaggedSymbol = T.type_alias do - T.all(Symbol, FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction::Type) + T.all( + Symbol, + FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction::Type + ) end OrSymbol = T.type_alias { T.any(Symbol, String) } FIXED = T.let( :fixed, - FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction::Type::TaggedSymbol + FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction::Type::TaggedSymbol ) PERCENT = T.let( :percent, - FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction::Type::TaggedSymbol + FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction::Type::TaggedSymbol ) sig do - override - .returns( - T::Array[ - FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction::Type::TaggedSymbol - ] - ) + override.returns( + T::Array[ + FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction::Type::TaggedSymbol + ] + ) + end + def self.values end - def self.values; end end end end diff --git a/rbi/finch_api/models/hris/benefits/individual_enrolled_ids_params.rbi b/rbi/finch_api/models/hris/benefits/individual_enrolled_ids_params.rbi index 8b5994f0..f4768c51 100644 --- a/rbi/finch_api/models/hris/benefits/individual_enrolled_ids_params.rbi +++ b/rbi/finch_api/models/hris/benefits/individual_enrolled_ids_params.rbi @@ -8,14 +8,22 @@ module FinchAPI extend FinchAPI::Internal::Type::RequestParameters::Converter include FinchAPI::Internal::Type::RequestParameters + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + sig do - params(request_options: T.any(FinchAPI::RequestOptions, FinchAPI::Internal::AnyHash)) - .returns(T.attached_class) + params(request_options: FinchAPI::RequestOptions::OrHash).returns( + T.attached_class + ) + end + def self.new(request_options: {}) end - def self.new(request_options: {}); end - sig { override.returns({request_options: FinchAPI::RequestOptions}) } - def to_hash; end + sig do + override.returns({ request_options: FinchAPI::RequestOptions }) + end + def to_hash + end end end end diff --git a/rbi/finch_api/models/hris/benefits/individual_enrolled_ids_response.rbi b/rbi/finch_api/models/hris/benefits/individual_enrolled_ids_response.rbi index 0b0cc1e7..ef4508db 100644 --- a/rbi/finch_api/models/hris/benefits/individual_enrolled_ids_response.rbi +++ b/rbi/finch_api/models/hris/benefits/individual_enrolled_ids_response.rbi @@ -5,6 +5,9 @@ module FinchAPI module HRIS module Benefits class IndividualEnrolledIDsResponse < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + # The id of the benefit. sig { returns(String) } attr_accessor :benefit_id @@ -12,14 +15,26 @@ module FinchAPI sig { returns(T::Array[String]) } attr_accessor :individual_ids - sig { params(benefit_id: String, individual_ids: T::Array[String]).returns(T.attached_class) } + sig do + params( + benefit_id: String, + individual_ids: T::Array[String] + ).returns(T.attached_class) + end def self.new( # The id of the benefit. benefit_id:, individual_ids: - ); end - sig { override.returns({benefit_id: String, individual_ids: T::Array[String]}) } - def to_hash; end + ) + end + + sig do + override.returns( + { benefit_id: String, individual_ids: T::Array[String] } + ) + end + def to_hash + end end end end diff --git a/rbi/finch_api/models/hris/benefits/individual_retrieve_many_benefits_params.rbi b/rbi/finch_api/models/hris/benefits/individual_retrieve_many_benefits_params.rbi index 87a02a46..3bf64914 100644 --- a/rbi/finch_api/models/hris/benefits/individual_retrieve_many_benefits_params.rbi +++ b/rbi/finch_api/models/hris/benefits/individual_retrieve_many_benefits_params.rbi @@ -8,6 +8,9 @@ module FinchAPI extend FinchAPI::Internal::Type::RequestParameters::Converter include FinchAPI::Internal::Type::RequestParameters + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + # comma-delimited list of stable Finch uuids for each individual. If empty, # defaults to all individuals sig { returns(T.nilable(String)) } @@ -19,18 +22,27 @@ module FinchAPI sig do params( individual_ids: String, - request_options: T.any(FinchAPI::RequestOptions, FinchAPI::Internal::AnyHash) - ) - .returns(T.attached_class) + request_options: FinchAPI::RequestOptions::OrHash + ).returns(T.attached_class) end def self.new( # comma-delimited list of stable Finch uuids for each individual. If empty, # defaults to all individuals individual_ids: nil, request_options: {} - ); end - sig { override.returns({individual_ids: String, request_options: FinchAPI::RequestOptions}) } - def to_hash; end + ) + end + + sig do + override.returns( + { + individual_ids: String, + request_options: FinchAPI::RequestOptions + } + ) + end + def to_hash + end end end end diff --git a/rbi/finch_api/models/hris/benefits/individual_unenroll_many_params.rbi b/rbi/finch_api/models/hris/benefits/individual_unenroll_many_params.rbi index f03f50a6..0e10126a 100644 --- a/rbi/finch_api/models/hris/benefits/individual_unenroll_many_params.rbi +++ b/rbi/finch_api/models/hris/benefits/individual_unenroll_many_params.rbi @@ -8,6 +8,9 @@ module FinchAPI extend FinchAPI::Internal::Type::RequestParameters::Converter include FinchAPI::Internal::Type::RequestParameters + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + # Array of individual_ids to unenroll. sig { returns(T.nilable(T::Array[String])) } attr_reader :individual_ids @@ -18,19 +21,26 @@ module FinchAPI sig do params( individual_ids: T::Array[String], - request_options: T.any(FinchAPI::RequestOptions, FinchAPI::Internal::AnyHash) - ) - .returns(T.attached_class) + request_options: FinchAPI::RequestOptions::OrHash + ).returns(T.attached_class) end def self.new( # Array of individual_ids to unenroll. individual_ids: nil, request_options: {} - ); end + ) + end + sig do - override.returns({individual_ids: T::Array[String], request_options: FinchAPI::RequestOptions}) + override.returns( + { + individual_ids: T::Array[String], + request_options: FinchAPI::RequestOptions + } + ) + end + def to_hash end - def to_hash; end end end end diff --git a/rbi/finch_api/models/hris/benefits/unenrolled_individual_benefit_response.rbi b/rbi/finch_api/models/hris/benefits/unenrolled_individual_benefit_response.rbi index b3264f20..b7e9ed62 100644 --- a/rbi/finch_api/models/hris/benefits/unenrolled_individual_benefit_response.rbi +++ b/rbi/finch_api/models/hris/benefits/unenrolled_individual_benefit_response.rbi @@ -5,14 +5,19 @@ module FinchAPI module HRIS module Benefits class UnenrolledIndividualBenefitResponse < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + sig { returns(String) } attr_accessor :job_id sig { params(job_id: String).returns(T.attached_class) } - def self.new(job_id:); end + def self.new(job_id:) + end - sig { override.returns({job_id: String}) } - def to_hash; end + sig { override.returns({ job_id: String }) } + def to_hash + end end end end diff --git a/rbi/finch_api/models/hris/benefits_support.rbi b/rbi/finch_api/models/hris/benefits_support.rbi index 344d0e92..3525e1fb 100644 --- a/rbi/finch_api/models/hris/benefits_support.rbi +++ b/rbi/finch_api/models/hris/benefits_support.rbi @@ -4,135 +4,138 @@ module FinchAPI module Models module HRIS class BenefitsSupport < FinchAPI::Internal::Type::BaseModel - sig { returns(T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations)) } + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + + sig { returns(T.nilable(FinchAPI::HRIS::BenefitFeaturesAndOperations)) } attr_reader :commuter sig do params( - commuter: T.nilable(T.any(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, FinchAPI::Internal::AnyHash)) - ) - .void + commuter: + T.nilable(FinchAPI::HRIS::BenefitFeaturesAndOperations::OrHash) + ).void end attr_writer :commuter - sig { returns(T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations)) } + sig { returns(T.nilable(FinchAPI::HRIS::BenefitFeaturesAndOperations)) } attr_reader :custom_post_tax sig do params( - custom_post_tax: T.nilable(T.any(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, FinchAPI::Internal::AnyHash)) - ) - .void + custom_post_tax: + T.nilable(FinchAPI::HRIS::BenefitFeaturesAndOperations::OrHash) + ).void end attr_writer :custom_post_tax - sig { returns(T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations)) } + sig { returns(T.nilable(FinchAPI::HRIS::BenefitFeaturesAndOperations)) } attr_reader :custom_pre_tax sig do params( - custom_pre_tax: T.nilable(T.any(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, FinchAPI::Internal::AnyHash)) - ) - .void + custom_pre_tax: + T.nilable(FinchAPI::HRIS::BenefitFeaturesAndOperations::OrHash) + ).void end attr_writer :custom_pre_tax - sig { returns(T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations)) } + sig { returns(T.nilable(FinchAPI::HRIS::BenefitFeaturesAndOperations)) } attr_reader :fsa_dependent_care sig do params( - fsa_dependent_care: T.nilable(T.any(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, FinchAPI::Internal::AnyHash)) - ) - .void + fsa_dependent_care: + T.nilable(FinchAPI::HRIS::BenefitFeaturesAndOperations::OrHash) + ).void end attr_writer :fsa_dependent_care - sig { returns(T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations)) } + sig { returns(T.nilable(FinchAPI::HRIS::BenefitFeaturesAndOperations)) } attr_reader :fsa_medical sig do params( - fsa_medical: T.nilable(T.any(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, FinchAPI::Internal::AnyHash)) - ) - .void + fsa_medical: + T.nilable(FinchAPI::HRIS::BenefitFeaturesAndOperations::OrHash) + ).void end attr_writer :fsa_medical - sig { returns(T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations)) } + sig { returns(T.nilable(FinchAPI::HRIS::BenefitFeaturesAndOperations)) } attr_reader :hsa_post sig do params( - hsa_post: T.nilable(T.any(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, FinchAPI::Internal::AnyHash)) - ) - .void + hsa_post: + T.nilable(FinchAPI::HRIS::BenefitFeaturesAndOperations::OrHash) + ).void end attr_writer :hsa_post - sig { returns(T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations)) } + sig { returns(T.nilable(FinchAPI::HRIS::BenefitFeaturesAndOperations)) } attr_reader :hsa_pre sig do params( - hsa_pre: T.nilable(T.any(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, FinchAPI::Internal::AnyHash)) - ) - .void + hsa_pre: + T.nilable(FinchAPI::HRIS::BenefitFeaturesAndOperations::OrHash) + ).void end attr_writer :hsa_pre - sig { returns(T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations)) } + sig { returns(T.nilable(FinchAPI::HRIS::BenefitFeaturesAndOperations)) } attr_reader :s125_dental sig do params( - s125_dental: T.nilable(T.any(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, FinchAPI::Internal::AnyHash)) - ) - .void + s125_dental: + T.nilable(FinchAPI::HRIS::BenefitFeaturesAndOperations::OrHash) + ).void end attr_writer :s125_dental - sig { returns(T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations)) } + sig { returns(T.nilable(FinchAPI::HRIS::BenefitFeaturesAndOperations)) } attr_reader :s125_medical sig do params( - s125_medical: T.nilable(T.any(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, FinchAPI::Internal::AnyHash)) - ) - .void + s125_medical: + T.nilable(FinchAPI::HRIS::BenefitFeaturesAndOperations::OrHash) + ).void end attr_writer :s125_medical - sig { returns(T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations)) } + sig { returns(T.nilable(FinchAPI::HRIS::BenefitFeaturesAndOperations)) } attr_reader :s125_vision sig do params( - s125_vision: T.nilable(T.any(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, FinchAPI::Internal::AnyHash)) - ) - .void + s125_vision: + T.nilable(FinchAPI::HRIS::BenefitFeaturesAndOperations::OrHash) + ).void end attr_writer :s125_vision - sig { returns(T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations)) } + sig { returns(T.nilable(FinchAPI::HRIS::BenefitFeaturesAndOperations)) } attr_reader :simple sig do params( - simple: T.nilable(T.any(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, FinchAPI::Internal::AnyHash)) - ) - .void + simple: + T.nilable(FinchAPI::HRIS::BenefitFeaturesAndOperations::OrHash) + ).void end attr_writer :simple - sig { returns(T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations)) } + sig { returns(T.nilable(FinchAPI::HRIS::BenefitFeaturesAndOperations)) } attr_reader :simple_ira sig do params( - simple_ira: T.nilable(T.any(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, FinchAPI::Internal::AnyHash)) - ) - .void + simple_ira: + T.nilable(FinchAPI::HRIS::BenefitFeaturesAndOperations::OrHash) + ).void end attr_writer :simple_ira @@ -140,20 +143,31 @@ module FinchAPI # supported, the property will be null sig do params( - commuter: T.nilable(T.any(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, FinchAPI::Internal::AnyHash)), - custom_post_tax: T.nilable(T.any(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, FinchAPI::Internal::AnyHash)), - custom_pre_tax: T.nilable(T.any(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, FinchAPI::Internal::AnyHash)), - fsa_dependent_care: T.nilable(T.any(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, FinchAPI::Internal::AnyHash)), - fsa_medical: T.nilable(T.any(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, FinchAPI::Internal::AnyHash)), - hsa_post: T.nilable(T.any(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, FinchAPI::Internal::AnyHash)), - hsa_pre: T.nilable(T.any(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, FinchAPI::Internal::AnyHash)), - s125_dental: T.nilable(T.any(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, FinchAPI::Internal::AnyHash)), - s125_medical: T.nilable(T.any(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, FinchAPI::Internal::AnyHash)), - s125_vision: T.nilable(T.any(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, FinchAPI::Internal::AnyHash)), - simple: T.nilable(T.any(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, FinchAPI::Internal::AnyHash)), - simple_ira: T.nilable(T.any(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, FinchAPI::Internal::AnyHash)) - ) - .returns(T.attached_class) + commuter: + T.nilable(FinchAPI::HRIS::BenefitFeaturesAndOperations::OrHash), + custom_post_tax: + T.nilable(FinchAPI::HRIS::BenefitFeaturesAndOperations::OrHash), + custom_pre_tax: + T.nilable(FinchAPI::HRIS::BenefitFeaturesAndOperations::OrHash), + fsa_dependent_care: + T.nilable(FinchAPI::HRIS::BenefitFeaturesAndOperations::OrHash), + fsa_medical: + T.nilable(FinchAPI::HRIS::BenefitFeaturesAndOperations::OrHash), + hsa_post: + T.nilable(FinchAPI::HRIS::BenefitFeaturesAndOperations::OrHash), + hsa_pre: + T.nilable(FinchAPI::HRIS::BenefitFeaturesAndOperations::OrHash), + s125_dental: + T.nilable(FinchAPI::HRIS::BenefitFeaturesAndOperations::OrHash), + s125_medical: + T.nilable(FinchAPI::HRIS::BenefitFeaturesAndOperations::OrHash), + s125_vision: + T.nilable(FinchAPI::HRIS::BenefitFeaturesAndOperations::OrHash), + simple: + T.nilable(FinchAPI::HRIS::BenefitFeaturesAndOperations::OrHash), + simple_ira: + T.nilable(FinchAPI::HRIS::BenefitFeaturesAndOperations::OrHash) + ).returns(T.attached_class) end def self.new( commuter: nil, @@ -168,27 +182,37 @@ module FinchAPI s125_vision: nil, simple: nil, simple_ira: nil - ); end + ) + end + sig do - override - .returns( - { - 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) - } - ) - end - def to_hash; end + override.returns( + { + commuter: T.nilable(FinchAPI::HRIS::BenefitFeaturesAndOperations), + custom_post_tax: + T.nilable(FinchAPI::HRIS::BenefitFeaturesAndOperations), + custom_pre_tax: + T.nilable(FinchAPI::HRIS::BenefitFeaturesAndOperations), + fsa_dependent_care: + T.nilable(FinchAPI::HRIS::BenefitFeaturesAndOperations), + fsa_medical: + T.nilable(FinchAPI::HRIS::BenefitFeaturesAndOperations), + hsa_post: T.nilable(FinchAPI::HRIS::BenefitFeaturesAndOperations), + hsa_pre: T.nilable(FinchAPI::HRIS::BenefitFeaturesAndOperations), + s125_dental: + T.nilable(FinchAPI::HRIS::BenefitFeaturesAndOperations), + s125_medical: + T.nilable(FinchAPI::HRIS::BenefitFeaturesAndOperations), + s125_vision: + T.nilable(FinchAPI::HRIS::BenefitFeaturesAndOperations), + simple: T.nilable(FinchAPI::HRIS::BenefitFeaturesAndOperations), + simple_ira: + T.nilable(FinchAPI::HRIS::BenefitFeaturesAndOperations) + } + ) + end + def to_hash + end end end end diff --git a/rbi/finch_api/models/hris/company.rbi b/rbi/finch_api/models/hris/company.rbi index 37c0455b..5c211263 100644 --- a/rbi/finch_api/models/hris/company.rbi +++ b/rbi/finch_api/models/hris/company.rbi @@ -4,16 +4,27 @@ module FinchAPI module Models module HRIS class HRISCompany < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + # A stable Finch `id` (UUID v4) for the company. sig { returns(String) } 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])) } + sig do + returns(T.nilable(T::Array[FinchAPI::HRIS::HRISCompany::Account])) + end attr_accessor :accounts # The array of company departments. - sig { returns(T.nilable(T::Array[T.nilable(FinchAPI::Models::HRIS::HRISCompany::Department)])) } + sig do + returns( + T.nilable( + T::Array[T.nilable(FinchAPI::HRIS::HRISCompany::Department)] + ) + ) + end attr_accessor :departments # The employer identification number. @@ -21,12 +32,13 @@ module FinchAPI attr_accessor :ein # The entity type object. - sig { returns(T.nilable(FinchAPI::Models::HRIS::HRISCompany::Entity)) } + sig { returns(T.nilable(FinchAPI::HRIS::HRISCompany::Entity)) } attr_reader :entity sig do - params(entity: T.nilable(T.any(FinchAPI::Models::HRIS::HRISCompany::Entity, FinchAPI::Internal::AnyHash))) - .void + params( + entity: T.nilable(FinchAPI::HRIS::HRISCompany::Entity::OrHash) + ).void end attr_writer :entity @@ -34,7 +46,7 @@ module FinchAPI sig { returns(T.nilable(String)) } attr_accessor :legal_name - sig { returns(T.nilable(T::Array[T.nilable(FinchAPI::Models::Location)])) } + sig { returns(T.nilable(T::Array[T.nilable(FinchAPI::Location)])) } attr_accessor :locations # The email of the main administrator on the account. @@ -49,18 +61,22 @@ module FinchAPI sig do params( id: String, - accounts: T.nilable(T::Array[T.any(FinchAPI::Models::HRIS::HRISCompany::Account, FinchAPI::Internal::AnyHash)]), - departments: T.nilable( - T::Array[T.nilable(T.any(FinchAPI::Models::HRIS::HRISCompany::Department, FinchAPI::Internal::AnyHash))] - ), + accounts: + T.nilable(T::Array[FinchAPI::HRIS::HRISCompany::Account::OrHash]), + departments: + T.nilable( + T::Array[ + T.nilable(FinchAPI::HRIS::HRISCompany::Department::OrHash) + ] + ), ein: T.nilable(String), - entity: T.nilable(T.any(FinchAPI::Models::HRIS::HRISCompany::Entity, FinchAPI::Internal::AnyHash)), + entity: T.nilable(FinchAPI::HRIS::HRISCompany::Entity::OrHash), legal_name: T.nilable(String), - locations: T.nilable(T::Array[T.nilable(T.any(FinchAPI::Models::Location, FinchAPI::Internal::AnyHash))]), + locations: + T.nilable(T::Array[T.nilable(FinchAPI::Location::OrHash)]), primary_email: T.nilable(String), primary_phone_number: T.nilable(String) - ) - .returns(T.attached_class) + ).returns(T.attached_class) end def self.new( # A stable Finch `id` (UUID v4) for the company. @@ -81,26 +97,35 @@ module FinchAPI # The phone number of the main administrator on the account. Format: E.164, with # extension where applicable, e.g. `+NNNNNNNNNNN xExtension` primary_phone_number: - ); end + ) + end + sig do - override - .returns( - { - id: String, - 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), - 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) - } - ) + override.returns( + { + id: String, + accounts: + T.nilable(T::Array[FinchAPI::HRIS::HRISCompany::Account]), + departments: + T.nilable( + T::Array[T.nilable(FinchAPI::HRIS::HRISCompany::Department)] + ), + ein: T.nilable(String), + entity: T.nilable(FinchAPI::HRIS::HRISCompany::Entity), + legal_name: T.nilable(String), + locations: T.nilable(T::Array[T.nilable(FinchAPI::Location)]), + primary_email: T.nilable(String), + primary_phone_number: T.nilable(String) + } + ) + end + def to_hash end - def to_hash; end class Account < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + # The name of the bank associated in the payroll/HRIS system. sig { returns(T.nilable(String)) } attr_accessor :account_name @@ -110,7 +135,13 @@ module FinchAPI attr_accessor :account_number # The type of bank account. - sig { returns(T.nilable(FinchAPI::Models::HRIS::HRISCompany::Account::AccountType::TaggedSymbol)) } + sig do + returns( + T.nilable( + FinchAPI::HRIS::HRISCompany::Account::AccountType::TaggedSymbol + ) + ) + end attr_accessor :account_type # Name of the banking institution. @@ -126,11 +157,13 @@ module FinchAPI params( account_name: T.nilable(String), account_number: T.nilable(String), - account_type: T.nilable(FinchAPI::Models::HRIS::HRISCompany::Account::AccountType::OrSymbol), + account_type: + T.nilable( + FinchAPI::HRIS::HRISCompany::Account::AccountType::OrSymbol + ), institution_name: T.nilable(String), routing_number: T.nilable(String) - ) - .returns(T.attached_class) + ).returns(T.attached_class) end def self.new( # The name of the bank associated in the payroll/HRIS system. @@ -144,75 +177,116 @@ module FinchAPI # A nine-digit code that's based on the U.S. Bank location where your account was # opened. routing_number: - ); end + ) + end + sig do - override - .returns( - { - account_name: T.nilable(String), - account_number: T.nilable(String), - account_type: T.nilable(FinchAPI::Models::HRIS::HRISCompany::Account::AccountType::TaggedSymbol), - institution_name: T.nilable(String), - routing_number: T.nilable(String) - } - ) + override.returns( + { + account_name: T.nilable(String), + account_number: T.nilable(String), + account_type: + T.nilable( + FinchAPI::HRIS::HRISCompany::Account::AccountType::TaggedSymbol + ), + institution_name: T.nilable(String), + routing_number: T.nilable(String) + } + ) + end + def to_hash end - def to_hash; end # The type of bank account. module AccountType extend FinchAPI::Internal::Type::Enum - TaggedSymbol = T.type_alias { T.all(Symbol, FinchAPI::Models::HRIS::HRISCompany::Account::AccountType) } + TaggedSymbol = + T.type_alias do + T.all(Symbol, FinchAPI::HRIS::HRISCompany::Account::AccountType) + end OrSymbol = T.type_alias { T.any(Symbol, String) } - CHECKING = T.let(:checking, FinchAPI::Models::HRIS::HRISCompany::Account::AccountType::TaggedSymbol) - SAVINGS = T.let(:savings, FinchAPI::Models::HRIS::HRISCompany::Account::AccountType::TaggedSymbol) + CHECKING = + T.let( + :checking, + FinchAPI::HRIS::HRISCompany::Account::AccountType::TaggedSymbol + ) + SAVINGS = + T.let( + :savings, + FinchAPI::HRIS::HRISCompany::Account::AccountType::TaggedSymbol + ) - sig { override.returns(T::Array[FinchAPI::Models::HRIS::HRISCompany::Account::AccountType::TaggedSymbol]) } - def self.values; end + sig do + override.returns( + T::Array[ + FinchAPI::HRIS::HRISCompany::Account::AccountType::TaggedSymbol + ] + ) + end + def self.values + end end end class Department < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + # The department name. sig { returns(T.nilable(String)) } attr_accessor :name # The parent department, if present. - sig { returns(T.nilable(FinchAPI::Models::HRIS::HRISCompany::Department::Parent)) } + sig do + returns(T.nilable(FinchAPI::HRIS::HRISCompany::Department::Parent)) + end attr_reader :parent sig do params( - parent: T.nilable(T.any(FinchAPI::Models::HRIS::HRISCompany::Department::Parent, FinchAPI::Internal::AnyHash)) - ) - .void + parent: + T.nilable( + FinchAPI::HRIS::HRISCompany::Department::Parent::OrHash + ) + ).void end attr_writer :parent sig do params( name: T.nilable(String), - parent: T.nilable(T.any(FinchAPI::Models::HRIS::HRISCompany::Department::Parent, FinchAPI::Internal::AnyHash)) - ) - .returns(T.attached_class) + parent: + T.nilable( + FinchAPI::HRIS::HRISCompany::Department::Parent::OrHash + ) + ).returns(T.attached_class) end def self.new( # The department name. name:, # The parent department, if present. parent: - ); end + ) + end + sig do - override - .returns( - {name: T.nilable(String), parent: T.nilable(FinchAPI::Models::HRIS::HRISCompany::Department::Parent)} - ) + override.returns( + { + name: T.nilable(String), + parent: + T.nilable(FinchAPI::HRIS::HRISCompany::Department::Parent) + } + ) + end + def to_hash end - def to_hash; end class Parent < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + # The parent department's name. sig { returns(T.nilable(String)) } attr_accessor :name @@ -222,79 +296,165 @@ module FinchAPI def self.new( # The parent department's name. name: - ); end - sig { override.returns({name: T.nilable(String)}) } - def to_hash; end + ) + end + + sig { override.returns({ name: T.nilable(String) }) } + def to_hash + end end end class Entity < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + # The tax payer subtype of the company. - sig { returns(T.nilable(FinchAPI::Models::HRIS::HRISCompany::Entity::Subtype::TaggedSymbol)) } + sig do + returns( + T.nilable( + FinchAPI::HRIS::HRISCompany::Entity::Subtype::TaggedSymbol + ) + ) + end attr_accessor :subtype # The tax payer type of the company. - sig { returns(T.nilable(FinchAPI::Models::HRIS::HRISCompany::Entity::Type::TaggedSymbol)) } + sig do + returns( + T.nilable(FinchAPI::HRIS::HRISCompany::Entity::Type::TaggedSymbol) + ) + end attr_accessor :type # The entity type object. sig do params( - subtype: T.nilable(FinchAPI::Models::HRIS::HRISCompany::Entity::Subtype::OrSymbol), - type: T.nilable(FinchAPI::Models::HRIS::HRISCompany::Entity::Type::OrSymbol) - ) - .returns(T.attached_class) + subtype: + T.nilable( + FinchAPI::HRIS::HRISCompany::Entity::Subtype::OrSymbol + ), + type: + T.nilable(FinchAPI::HRIS::HRISCompany::Entity::Type::OrSymbol) + ).returns(T.attached_class) end def self.new( # The tax payer subtype of the company. subtype:, # The tax payer type of the company. type: - ); end + ) + end + sig do - override - .returns( - { - subtype: T.nilable(FinchAPI::Models::HRIS::HRISCompany::Entity::Subtype::TaggedSymbol), - type: T.nilable(FinchAPI::Models::HRIS::HRISCompany::Entity::Type::TaggedSymbol) - } - ) + override.returns( + { + subtype: + T.nilable( + FinchAPI::HRIS::HRISCompany::Entity::Subtype::TaggedSymbol + ), + type: + T.nilable( + FinchAPI::HRIS::HRISCompany::Entity::Type::TaggedSymbol + ) + } + ) + end + def to_hash end - def to_hash; end # The tax payer subtype of the company. module Subtype extend FinchAPI::Internal::Type::Enum - TaggedSymbol = T.type_alias { T.all(Symbol, FinchAPI::Models::HRIS::HRISCompany::Entity::Subtype) } + TaggedSymbol = + T.type_alias do + T.all(Symbol, FinchAPI::HRIS::HRISCompany::Entity::Subtype) + end OrSymbol = T.type_alias { T.any(Symbol, String) } - 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) + S_CORPORATION = + T.let( + :s_corporation, + FinchAPI::HRIS::HRISCompany::Entity::Subtype::TaggedSymbol + ) + C_CORPORATION = + T.let( + :c_corporation, + FinchAPI::HRIS::HRISCompany::Entity::Subtype::TaggedSymbol + ) + B_CORPORATION = + T.let( + :b_corporation, + FinchAPI::HRIS::HRISCompany::Entity::Subtype::TaggedSymbol + ) - sig { override.returns(T::Array[FinchAPI::Models::HRIS::HRISCompany::Entity::Subtype::TaggedSymbol]) } - def self.values; end + sig do + override.returns( + T::Array[ + FinchAPI::HRIS::HRISCompany::Entity::Subtype::TaggedSymbol + ] + ) + end + def self.values + end end # The tax payer type of the company. module Type extend FinchAPI::Internal::Type::Enum - TaggedSymbol = T.type_alias { T.all(Symbol, FinchAPI::Models::HRIS::HRISCompany::Entity::Type) } + TaggedSymbol = + T.type_alias do + T.all(Symbol, FinchAPI::HRIS::HRISCompany::Entity::Type) + end OrSymbol = T.type_alias { T.any(Symbol, String) } - 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) + LLC = + T.let( + :llc, + FinchAPI::HRIS::HRISCompany::Entity::Type::TaggedSymbol + ) + LP = + T.let( + :lp, + FinchAPI::HRIS::HRISCompany::Entity::Type::TaggedSymbol + ) + CORPORATION = + T.let( + :corporation, + FinchAPI::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) + T.let( + :sole_proprietor, + FinchAPI::HRIS::HRISCompany::Entity::Type::TaggedSymbol + ) + NON_PROFIT = + T.let( + :non_profit, + FinchAPI::HRIS::HRISCompany::Entity::Type::TaggedSymbol + ) + PARTNERSHIP = + T.let( + :partnership, + FinchAPI::HRIS::HRISCompany::Entity::Type::TaggedSymbol + ) + COOPERATIVE = + T.let( + :cooperative, + FinchAPI::HRIS::HRISCompany::Entity::Type::TaggedSymbol + ) - sig { override.returns(T::Array[FinchAPI::Models::HRIS::HRISCompany::Entity::Type::TaggedSymbol]) } - def self.values; end + sig do + override.returns( + T::Array[ + FinchAPI::HRIS::HRISCompany::Entity::Type::TaggedSymbol + ] + ) + end + def self.values + end end end end diff --git a/rbi/finch_api/models/hris/company/pay_statement_item/rule_create_params.rbi b/rbi/finch_api/models/hris/company/pay_statement_item/rule_create_params.rbi index b01a6c02..31a5d81d 100644 --- a/rbi/finch_api/models/hris/company/pay_statement_item/rule_create_params.rbi +++ b/rbi/finch_api/models/hris/company/pay_statement_item/rule_create_params.rbi @@ -9,38 +9,45 @@ module FinchAPI extend FinchAPI::Internal::Type::RequestParameters::Converter include FinchAPI::Internal::Type::RequestParameters + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + # Specifies the fields to be applied when the condition is met. - sig { returns(T.nilable(FinchAPI::Models::HRIS::Company::PayStatementItem::RuleCreateParams::Attributes)) } + sig do + returns( + T.nilable( + FinchAPI::HRIS::Company::PayStatementItem::RuleCreateParams::Attributes + ) + ) + end attr_reader :attributes sig do params( - attributes: T.any( - FinchAPI::Models::HRIS::Company::PayStatementItem::RuleCreateParams::Attributes, - FinchAPI::Internal::AnyHash - ) - ) - .void + attributes: + FinchAPI::HRIS::Company::PayStatementItem::RuleCreateParams::Attributes::OrHash + ).void end attr_writer :attributes sig do returns( - T.nilable(T::Array[FinchAPI::Models::HRIS::Company::PayStatementItem::RuleCreateParams::Condition]) + T.nilable( + T::Array[ + FinchAPI::HRIS::Company::PayStatementItem::RuleCreateParams::Condition + ] + ) ) end attr_reader :conditions sig do params( - conditions: T::Array[ - T.any( - FinchAPI::Models::HRIS::Company::PayStatementItem::RuleCreateParams::Condition, - FinchAPI::Internal::AnyHash - ) - ] - ) - .void + conditions: + T::Array[ + FinchAPI::HRIS::Company::PayStatementItem::RuleCreateParams::Condition::OrHash + ] + ).void end attr_writer :conditions @@ -55,37 +62,35 @@ module FinchAPI # The entity type to which the rule is applied. sig do returns( - T.nilable(FinchAPI::Models::HRIS::Company::PayStatementItem::RuleCreateParams::EntityType::OrSymbol) + T.nilable( + FinchAPI::HRIS::Company::PayStatementItem::RuleCreateParams::EntityType::OrSymbol + ) ) end attr_reader :entity_type sig do params( - entity_type: FinchAPI::Models::HRIS::Company::PayStatementItem::RuleCreateParams::EntityType::OrSymbol - ) - .void + entity_type: + FinchAPI::HRIS::Company::PayStatementItem::RuleCreateParams::EntityType::OrSymbol + ).void end attr_writer :entity_type sig do params( - attributes: T.any( - FinchAPI::Models::HRIS::Company::PayStatementItem::RuleCreateParams::Attributes, - FinchAPI::Internal::AnyHash - ), - conditions: T::Array[ - T.any( - FinchAPI::Models::HRIS::Company::PayStatementItem::RuleCreateParams::Condition, - FinchAPI::Internal::AnyHash - ) - ], + attributes: + FinchAPI::HRIS::Company::PayStatementItem::RuleCreateParams::Attributes::OrHash, + conditions: + T::Array[ + FinchAPI::HRIS::Company::PayStatementItem::RuleCreateParams::Condition::OrHash + ], effective_end_date: T.nilable(String), effective_start_date: T.nilable(String), - entity_type: FinchAPI::Models::HRIS::Company::PayStatementItem::RuleCreateParams::EntityType::OrSymbol, - request_options: T.any(FinchAPI::RequestOptions, FinchAPI::Internal::AnyHash) - ) - .returns(T.attached_class) + entity_type: + FinchAPI::HRIS::Company::PayStatementItem::RuleCreateParams::EntityType::OrSymbol, + request_options: FinchAPI::RequestOptions::OrHash + ).returns(T.attached_class) end def self.new( # Specifies the fields to be applied when the condition is met. @@ -98,23 +103,33 @@ module FinchAPI # The entity type to which the rule is applied. entity_type: nil, request_options: {} - ); end + ) + end + sig do - override - .returns( - { - attributes: FinchAPI::Models::HRIS::Company::PayStatementItem::RuleCreateParams::Attributes, - conditions: T::Array[FinchAPI::Models::HRIS::Company::PayStatementItem::RuleCreateParams::Condition], - effective_end_date: T.nilable(String), - effective_start_date: T.nilable(String), - entity_type: FinchAPI::Models::HRIS::Company::PayStatementItem::RuleCreateParams::EntityType::OrSymbol, - request_options: FinchAPI::RequestOptions - } - ) + override.returns( + { + attributes: + FinchAPI::HRIS::Company::PayStatementItem::RuleCreateParams::Attributes, + conditions: + T::Array[ + FinchAPI::HRIS::Company::PayStatementItem::RuleCreateParams::Condition + ], + effective_end_date: T.nilable(String), + effective_start_date: T.nilable(String), + entity_type: + FinchAPI::HRIS::Company::PayStatementItem::RuleCreateParams::EntityType::OrSymbol, + request_options: FinchAPI::RequestOptions + } + ) + end + def to_hash end - def to_hash; end class Attributes < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + # The metadata to be attached in the entity. 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])) } @@ -124,17 +139,29 @@ module FinchAPI attr_writer :metadata # Specifies the fields to be applied when the condition is met. - sig { params(metadata: T::Hash[Symbol, T.anything]).returns(T.attached_class) } + sig do + params(metadata: T::Hash[Symbol, T.anything]).returns( + T.attached_class + ) + end def self.new( # The metadata to be attached in the entity. It is a key-value pairs where the # values can be of any type (string, number, boolean, object, array, etc.). metadata: nil - ); end - sig { override.returns({metadata: T::Hash[Symbol, T.anything]}) } - def to_hash; end + ) + end + + sig do + override.returns({ metadata: T::Hash[Symbol, T.anything] }) + end + def to_hash + end end class Condition < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + # The field to be checked in the rule. sig { returns(T.nilable(String)) } attr_reader :field @@ -146,7 +173,7 @@ module FinchAPI sig do returns( T.nilable( - FinchAPI::Models::HRIS::Company::PayStatementItem::RuleCreateParams::Condition::Operator::OrSymbol + FinchAPI::HRIS::Company::PayStatementItem::RuleCreateParams::Condition::Operator::OrSymbol ) ) end @@ -154,9 +181,9 @@ module FinchAPI sig do params( - operator: FinchAPI::Models::HRIS::Company::PayStatementItem::RuleCreateParams::Condition::Operator::OrSymbol - ) - .void + operator: + FinchAPI::HRIS::Company::PayStatementItem::RuleCreateParams::Condition::Operator::OrSymbol + ).void end attr_writer :operator @@ -170,10 +197,10 @@ module FinchAPI sig do params( field: String, - operator: FinchAPI::Models::HRIS::Company::PayStatementItem::RuleCreateParams::Condition::Operator::OrSymbol, + operator: + FinchAPI::HRIS::Company::PayStatementItem::RuleCreateParams::Condition::Operator::OrSymbol, value: String - ) - .returns(T.attached_class) + ).returns(T.attached_class) end def self.new( # The field to be checked in the rule. @@ -182,40 +209,50 @@ module FinchAPI operator: nil, # The value of the field to be checked in the rule. value: nil - ); end + ) + end + sig do - override - .returns( - { - field: String, - operator: FinchAPI::Models::HRIS::Company::PayStatementItem::RuleCreateParams::Condition::Operator::OrSymbol, - value: String - } - ) + override.returns( + { + field: String, + operator: + FinchAPI::HRIS::Company::PayStatementItem::RuleCreateParams::Condition::Operator::OrSymbol, + value: String + } + ) + end + def to_hash end - def to_hash; end # The operator to be used in the rule. module Operator extend FinchAPI::Internal::Type::Enum TaggedSymbol = - T.type_alias { T.all(Symbol, FinchAPI::Models::HRIS::Company::PayStatementItem::RuleCreateParams::Condition::Operator) } + T.type_alias do + T.all( + Symbol, + FinchAPI::HRIS::Company::PayStatementItem::RuleCreateParams::Condition::Operator + ) + end OrSymbol = T.type_alias { T.any(Symbol, String) } EQUALS = T.let( :equals, - FinchAPI::Models::HRIS::Company::PayStatementItem::RuleCreateParams::Condition::Operator::TaggedSymbol + FinchAPI::HRIS::Company::PayStatementItem::RuleCreateParams::Condition::Operator::TaggedSymbol ) sig do - override - .returns( - T::Array[FinchAPI::Models::HRIS::Company::PayStatementItem::RuleCreateParams::Condition::Operator::TaggedSymbol] - ) + override.returns( + T::Array[ + FinchAPI::HRIS::Company::PayStatementItem::RuleCreateParams::Condition::Operator::TaggedSymbol + ] + ) + end + def self.values end - def self.values; end end end @@ -224,22 +261,29 @@ module FinchAPI extend FinchAPI::Internal::Type::Enum TaggedSymbol = - T.type_alias { T.all(Symbol, FinchAPI::Models::HRIS::Company::PayStatementItem::RuleCreateParams::EntityType) } + T.type_alias do + T.all( + Symbol, + FinchAPI::HRIS::Company::PayStatementItem::RuleCreateParams::EntityType + ) + end OrSymbol = T.type_alias { T.any(Symbol, String) } PAY_STATEMENT_ITEM = T.let( :pay_statement_item, - FinchAPI::Models::HRIS::Company::PayStatementItem::RuleCreateParams::EntityType::TaggedSymbol + FinchAPI::HRIS::Company::PayStatementItem::RuleCreateParams::EntityType::TaggedSymbol ) sig do - override - .returns( - T::Array[FinchAPI::Models::HRIS::Company::PayStatementItem::RuleCreateParams::EntityType::TaggedSymbol] - ) + override.returns( + T::Array[ + FinchAPI::HRIS::Company::PayStatementItem::RuleCreateParams::EntityType::TaggedSymbol + ] + ) + end + def self.values end - def self.values; end end end end diff --git a/rbi/finch_api/models/hris/company/pay_statement_item/rule_create_response.rbi b/rbi/finch_api/models/hris/company/pay_statement_item/rule_create_response.rbi index 736ce24e..92229457 100644 --- a/rbi/finch_api/models/hris/company/pay_statement_item/rule_create_response.rbi +++ b/rbi/finch_api/models/hris/company/pay_statement_item/rule_create_response.rbi @@ -6,6 +6,9 @@ module FinchAPI module Company module PayStatementItem class RuleCreateResponse < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + # Finch id (uuidv4) for the rule. sig { returns(T.nilable(String)) } attr_reader :id @@ -14,37 +17,41 @@ module FinchAPI attr_writer :id # Specifies the fields to be applied when the condition is met. - sig { returns(T.nilable(FinchAPI::Models::HRIS::Company::PayStatementItem::RuleCreateResponse::Attributes)) } + sig do + returns( + T.nilable( + FinchAPI::Models::HRIS::Company::PayStatementItem::RuleCreateResponse::Attributes + ) + ) + end attr_reader :attributes sig do params( - attributes: T.any( - FinchAPI::Models::HRIS::Company::PayStatementItem::RuleCreateResponse::Attributes, - FinchAPI::Internal::AnyHash - ) - ) - .void + attributes: + FinchAPI::Models::HRIS::Company::PayStatementItem::RuleCreateResponse::Attributes::OrHash + ).void end attr_writer :attributes sig do returns( - T.nilable(T::Array[FinchAPI::Models::HRIS::Company::PayStatementItem::RuleCreateResponse::Condition]) + T.nilable( + T::Array[ + FinchAPI::Models::HRIS::Company::PayStatementItem::RuleCreateResponse::Condition + ] + ) ) end attr_reader :conditions sig do params( - conditions: T::Array[ - T.any( - FinchAPI::Models::HRIS::Company::PayStatementItem::RuleCreateResponse::Condition, - FinchAPI::Internal::AnyHash - ) - ] - ) - .void + conditions: + T::Array[ + FinchAPI::Models::HRIS::Company::PayStatementItem::RuleCreateResponse::Condition::OrHash + ] + ).void end attr_writer :conditions @@ -66,16 +73,18 @@ module FinchAPI # The entity type to which the rule is applied. sig do returns( - T.nilable(FinchAPI::Models::HRIS::Company::PayStatementItem::RuleCreateResponse::EntityType::TaggedSymbol) + T.nilable( + FinchAPI::Models::HRIS::Company::PayStatementItem::RuleCreateResponse::EntityType::TaggedSymbol + ) ) end attr_reader :entity_type sig do params( - entity_type: FinchAPI::Models::HRIS::Company::PayStatementItem::RuleCreateResponse::EntityType::OrSymbol - ) - .void + entity_type: + FinchAPI::Models::HRIS::Company::PayStatementItem::RuleCreateResponse::EntityType::OrSymbol + ).void end attr_writer :entity_type @@ -96,24 +105,20 @@ module FinchAPI sig do params( id: String, - attributes: T.any( - FinchAPI::Models::HRIS::Company::PayStatementItem::RuleCreateResponse::Attributes, - FinchAPI::Internal::AnyHash - ), - conditions: T::Array[ - T.any( - FinchAPI::Models::HRIS::Company::PayStatementItem::RuleCreateResponse::Condition, - FinchAPI::Internal::AnyHash - ) - ], + attributes: + FinchAPI::Models::HRIS::Company::PayStatementItem::RuleCreateResponse::Attributes::OrHash, + conditions: + T::Array[ + FinchAPI::Models::HRIS::Company::PayStatementItem::RuleCreateResponse::Condition::OrHash + ], created_at: Time, effective_end_date: T.nilable(String), effective_start_date: T.nilable(String), - entity_type: FinchAPI::Models::HRIS::Company::PayStatementItem::RuleCreateResponse::EntityType::OrSymbol, + entity_type: + FinchAPI::Models::HRIS::Company::PayStatementItem::RuleCreateResponse::EntityType::OrSymbol, priority: Integer, updated_at: Time - ) - .returns(T.attached_class) + ).returns(T.attached_class) end def self.new( # Finch id (uuidv4) for the rule. @@ -133,26 +138,36 @@ module FinchAPI priority: nil, # The datetime when the rule was last updated. updated_at: nil - ); end + ) + end + sig do - override - .returns( - { - id: String, - attributes: FinchAPI::Models::HRIS::Company::PayStatementItem::RuleCreateResponse::Attributes, - conditions: T::Array[FinchAPI::Models::HRIS::Company::PayStatementItem::RuleCreateResponse::Condition], - created_at: Time, - effective_end_date: T.nilable(String), - effective_start_date: T.nilable(String), - entity_type: FinchAPI::Models::HRIS::Company::PayStatementItem::RuleCreateResponse::EntityType::TaggedSymbol, - priority: Integer, - updated_at: Time - } - ) + override.returns( + { + id: String, + attributes: + FinchAPI::Models::HRIS::Company::PayStatementItem::RuleCreateResponse::Attributes, + conditions: + T::Array[ + FinchAPI::Models::HRIS::Company::PayStatementItem::RuleCreateResponse::Condition + ], + created_at: Time, + effective_end_date: T.nilable(String), + effective_start_date: T.nilable(String), + entity_type: + FinchAPI::Models::HRIS::Company::PayStatementItem::RuleCreateResponse::EntityType::TaggedSymbol, + priority: Integer, + updated_at: Time + } + ) + end + def to_hash end - def to_hash; end class Attributes < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + # The metadata to be attached in the entity. 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])) } @@ -162,17 +177,29 @@ module FinchAPI attr_writer :metadata # Specifies the fields to be applied when the condition is met. - sig { params(metadata: T::Hash[Symbol, T.anything]).returns(T.attached_class) } + sig do + params(metadata: T::Hash[Symbol, T.anything]).returns( + T.attached_class + ) + end def self.new( # The metadata to be attached in the entity. It is a key-value pairs where the # values can be of any type (string, number, boolean, object, array, etc.). metadata: nil - ); end - sig { override.returns({metadata: T::Hash[Symbol, T.anything]}) } - def to_hash; end + ) + end + + sig do + override.returns({ metadata: T::Hash[Symbol, T.anything] }) + end + def to_hash + end end class Condition < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + # The field to be checked in the rule. sig { returns(T.nilable(String)) } attr_reader :field @@ -192,9 +219,9 @@ module FinchAPI sig do params( - operator: FinchAPI::Models::HRIS::Company::PayStatementItem::RuleCreateResponse::Condition::Operator::OrSymbol - ) - .void + operator: + FinchAPI::Models::HRIS::Company::PayStatementItem::RuleCreateResponse::Condition::Operator::OrSymbol + ).void end attr_writer :operator @@ -208,10 +235,10 @@ module FinchAPI sig do params( field: String, - operator: FinchAPI::Models::HRIS::Company::PayStatementItem::RuleCreateResponse::Condition::Operator::OrSymbol, + operator: + FinchAPI::Models::HRIS::Company::PayStatementItem::RuleCreateResponse::Condition::Operator::OrSymbol, value: String - ) - .returns(T.attached_class) + ).returns(T.attached_class) end def self.new( # The field to be checked in the rule. @@ -220,25 +247,33 @@ module FinchAPI operator: nil, # The value of the field to be checked in the rule. value: nil - ); end + ) + end + sig do - override - .returns( - { - field: String, - operator: FinchAPI::Models::HRIS::Company::PayStatementItem::RuleCreateResponse::Condition::Operator::TaggedSymbol, - value: String - } - ) + override.returns( + { + field: String, + operator: + FinchAPI::Models::HRIS::Company::PayStatementItem::RuleCreateResponse::Condition::Operator::TaggedSymbol, + value: String + } + ) + end + def to_hash end - def to_hash; end # The operator to be used in the rule. module Operator extend FinchAPI::Internal::Type::Enum TaggedSymbol = - T.type_alias { T.all(Symbol, FinchAPI::Models::HRIS::Company::PayStatementItem::RuleCreateResponse::Condition::Operator) } + T.type_alias do + T.all( + Symbol, + FinchAPI::Models::HRIS::Company::PayStatementItem::RuleCreateResponse::Condition::Operator + ) + end OrSymbol = T.type_alias { T.any(Symbol, String) } EQUALS = @@ -248,12 +283,14 @@ module FinchAPI ) sig do - override - .returns( - T::Array[FinchAPI::Models::HRIS::Company::PayStatementItem::RuleCreateResponse::Condition::Operator::TaggedSymbol] - ) + override.returns( + T::Array[ + FinchAPI::Models::HRIS::Company::PayStatementItem::RuleCreateResponse::Condition::Operator::TaggedSymbol + ] + ) + end + def self.values end - def self.values; end end end @@ -262,7 +299,12 @@ module FinchAPI extend FinchAPI::Internal::Type::Enum TaggedSymbol = - T.type_alias { T.all(Symbol, FinchAPI::Models::HRIS::Company::PayStatementItem::RuleCreateResponse::EntityType) } + T.type_alias do + T.all( + Symbol, + FinchAPI::Models::HRIS::Company::PayStatementItem::RuleCreateResponse::EntityType + ) + end OrSymbol = T.type_alias { T.any(Symbol, String) } PAY_STATEMENT_ITEM = @@ -272,12 +314,14 @@ module FinchAPI ) sig do - override - .returns( - T::Array[FinchAPI::Models::HRIS::Company::PayStatementItem::RuleCreateResponse::EntityType::TaggedSymbol] - ) + override.returns( + T::Array[ + FinchAPI::Models::HRIS::Company::PayStatementItem::RuleCreateResponse::EntityType::TaggedSymbol + ] + ) + end + def self.values end - def self.values; end end end end diff --git a/rbi/finch_api/models/hris/company/pay_statement_item/rule_delete_params.rbi b/rbi/finch_api/models/hris/company/pay_statement_item/rule_delete_params.rbi index 15287c35..ea99b7c0 100644 --- a/rbi/finch_api/models/hris/company/pay_statement_item/rule_delete_params.rbi +++ b/rbi/finch_api/models/hris/company/pay_statement_item/rule_delete_params.rbi @@ -9,14 +9,22 @@ module FinchAPI extend FinchAPI::Internal::Type::RequestParameters::Converter include FinchAPI::Internal::Type::RequestParameters + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + sig do - params(request_options: T.any(FinchAPI::RequestOptions, FinchAPI::Internal::AnyHash)) - .returns(T.attached_class) + params(request_options: FinchAPI::RequestOptions::OrHash).returns( + T.attached_class + ) + end + def self.new(request_options: {}) end - def self.new(request_options: {}); end - sig { override.returns({request_options: FinchAPI::RequestOptions}) } - def to_hash; end + sig do + override.returns({ request_options: FinchAPI::RequestOptions }) + end + def to_hash + end end end end diff --git a/rbi/finch_api/models/hris/company/pay_statement_item/rule_delete_response.rbi b/rbi/finch_api/models/hris/company/pay_statement_item/rule_delete_response.rbi index 1d6f52ad..61f9912b 100644 --- a/rbi/finch_api/models/hris/company/pay_statement_item/rule_delete_response.rbi +++ b/rbi/finch_api/models/hris/company/pay_statement_item/rule_delete_response.rbi @@ -6,6 +6,9 @@ module FinchAPI module Company module PayStatementItem class RuleDeleteResponse < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + # Finch id (uuidv4) for the rule. sig { returns(T.nilable(String)) } attr_reader :id @@ -14,37 +17,41 @@ module FinchAPI attr_writer :id # Specifies the fields to be applied when the condition is met. - sig { returns(T.nilable(FinchAPI::Models::HRIS::Company::PayStatementItem::RuleDeleteResponse::Attributes)) } + sig do + returns( + T.nilable( + FinchAPI::Models::HRIS::Company::PayStatementItem::RuleDeleteResponse::Attributes + ) + ) + end attr_reader :attributes sig do params( - attributes: T.any( - FinchAPI::Models::HRIS::Company::PayStatementItem::RuleDeleteResponse::Attributes, - FinchAPI::Internal::AnyHash - ) - ) - .void + attributes: + FinchAPI::Models::HRIS::Company::PayStatementItem::RuleDeleteResponse::Attributes::OrHash + ).void end attr_writer :attributes sig do returns( - T.nilable(T::Array[FinchAPI::Models::HRIS::Company::PayStatementItem::RuleDeleteResponse::Condition]) + T.nilable( + T::Array[ + FinchAPI::Models::HRIS::Company::PayStatementItem::RuleDeleteResponse::Condition + ] + ) ) end attr_reader :conditions sig do params( - conditions: T::Array[ - T.any( - FinchAPI::Models::HRIS::Company::PayStatementItem::RuleDeleteResponse::Condition, - FinchAPI::Internal::AnyHash - ) - ] - ) - .void + conditions: + T::Array[ + FinchAPI::Models::HRIS::Company::PayStatementItem::RuleDeleteResponse::Condition::OrHash + ] + ).void end attr_writer :conditions @@ -73,16 +80,18 @@ module FinchAPI # The entity type to which the rule is applied. sig do returns( - T.nilable(FinchAPI::Models::HRIS::Company::PayStatementItem::RuleDeleteResponse::EntityType::TaggedSymbol) + T.nilable( + FinchAPI::Models::HRIS::Company::PayStatementItem::RuleDeleteResponse::EntityType::TaggedSymbol + ) ) end attr_reader :entity_type sig do params( - entity_type: FinchAPI::Models::HRIS::Company::PayStatementItem::RuleDeleteResponse::EntityType::OrSymbol - ) - .void + entity_type: + FinchAPI::Models::HRIS::Company::PayStatementItem::RuleDeleteResponse::EntityType::OrSymbol + ).void end attr_writer :entity_type @@ -103,25 +112,21 @@ module FinchAPI sig do params( id: String, - attributes: T.any( - FinchAPI::Models::HRIS::Company::PayStatementItem::RuleDeleteResponse::Attributes, - FinchAPI::Internal::AnyHash - ), - conditions: T::Array[ - T.any( - FinchAPI::Models::HRIS::Company::PayStatementItem::RuleDeleteResponse::Condition, - FinchAPI::Internal::AnyHash - ) - ], + attributes: + FinchAPI::Models::HRIS::Company::PayStatementItem::RuleDeleteResponse::Attributes::OrHash, + conditions: + T::Array[ + FinchAPI::Models::HRIS::Company::PayStatementItem::RuleDeleteResponse::Condition::OrHash + ], created_at: Time, deleted_at: Time, effective_end_date: T.nilable(String), effective_start_date: T.nilable(String), - entity_type: FinchAPI::Models::HRIS::Company::PayStatementItem::RuleDeleteResponse::EntityType::OrSymbol, + entity_type: + FinchAPI::Models::HRIS::Company::PayStatementItem::RuleDeleteResponse::EntityType::OrSymbol, priority: Integer, updated_at: Time - ) - .returns(T.attached_class) + ).returns(T.attached_class) end def self.new( # Finch id (uuidv4) for the rule. @@ -143,27 +148,37 @@ module FinchAPI priority: nil, # The datetime when the rule was last updated. updated_at: nil - ); end + ) + end + sig do - override - .returns( - { - id: String, - attributes: FinchAPI::Models::HRIS::Company::PayStatementItem::RuleDeleteResponse::Attributes, - conditions: T::Array[FinchAPI::Models::HRIS::Company::PayStatementItem::RuleDeleteResponse::Condition], - created_at: Time, - deleted_at: Time, - effective_end_date: T.nilable(String), - effective_start_date: T.nilable(String), - entity_type: FinchAPI::Models::HRIS::Company::PayStatementItem::RuleDeleteResponse::EntityType::TaggedSymbol, - priority: Integer, - updated_at: Time - } - ) + override.returns( + { + id: String, + attributes: + FinchAPI::Models::HRIS::Company::PayStatementItem::RuleDeleteResponse::Attributes, + conditions: + T::Array[ + FinchAPI::Models::HRIS::Company::PayStatementItem::RuleDeleteResponse::Condition + ], + created_at: Time, + deleted_at: Time, + effective_end_date: T.nilable(String), + effective_start_date: T.nilable(String), + entity_type: + FinchAPI::Models::HRIS::Company::PayStatementItem::RuleDeleteResponse::EntityType::TaggedSymbol, + priority: Integer, + updated_at: Time + } + ) + end + def to_hash end - def to_hash; end class Attributes < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + # The metadata to be attached in the entity. 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])) } @@ -173,17 +188,29 @@ module FinchAPI attr_writer :metadata # Specifies the fields to be applied when the condition is met. - sig { params(metadata: T::Hash[Symbol, T.anything]).returns(T.attached_class) } + sig do + params(metadata: T::Hash[Symbol, T.anything]).returns( + T.attached_class + ) + end def self.new( # The metadata to be attached in the entity. It is a key-value pairs where the # values can be of any type (string, number, boolean, object, array, etc.). metadata: nil - ); end - sig { override.returns({metadata: T::Hash[Symbol, T.anything]}) } - def to_hash; end + ) + end + + sig do + override.returns({ metadata: T::Hash[Symbol, T.anything] }) + end + def to_hash + end end class Condition < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + # The field to be checked in the rule. sig { returns(T.nilable(String)) } attr_reader :field @@ -203,9 +230,9 @@ module FinchAPI sig do params( - operator: FinchAPI::Models::HRIS::Company::PayStatementItem::RuleDeleteResponse::Condition::Operator::OrSymbol - ) - .void + operator: + FinchAPI::Models::HRIS::Company::PayStatementItem::RuleDeleteResponse::Condition::Operator::OrSymbol + ).void end attr_writer :operator @@ -219,10 +246,10 @@ module FinchAPI sig do params( field: String, - operator: FinchAPI::Models::HRIS::Company::PayStatementItem::RuleDeleteResponse::Condition::Operator::OrSymbol, + operator: + FinchAPI::Models::HRIS::Company::PayStatementItem::RuleDeleteResponse::Condition::Operator::OrSymbol, value: String - ) - .returns(T.attached_class) + ).returns(T.attached_class) end def self.new( # The field to be checked in the rule. @@ -231,25 +258,33 @@ module FinchAPI operator: nil, # The value of the field to be checked in the rule. value: nil - ); end + ) + end + sig do - override - .returns( - { - field: String, - operator: FinchAPI::Models::HRIS::Company::PayStatementItem::RuleDeleteResponse::Condition::Operator::TaggedSymbol, - value: String - } - ) + override.returns( + { + field: String, + operator: + FinchAPI::Models::HRIS::Company::PayStatementItem::RuleDeleteResponse::Condition::Operator::TaggedSymbol, + value: String + } + ) + end + def to_hash end - def to_hash; end # The operator to be used in the rule. module Operator extend FinchAPI::Internal::Type::Enum TaggedSymbol = - T.type_alias { T.all(Symbol, FinchAPI::Models::HRIS::Company::PayStatementItem::RuleDeleteResponse::Condition::Operator) } + T.type_alias do + T.all( + Symbol, + FinchAPI::Models::HRIS::Company::PayStatementItem::RuleDeleteResponse::Condition::Operator + ) + end OrSymbol = T.type_alias { T.any(Symbol, String) } EQUALS = @@ -259,12 +294,14 @@ module FinchAPI ) sig do - override - .returns( - T::Array[FinchAPI::Models::HRIS::Company::PayStatementItem::RuleDeleteResponse::Condition::Operator::TaggedSymbol] - ) + override.returns( + T::Array[ + FinchAPI::Models::HRIS::Company::PayStatementItem::RuleDeleteResponse::Condition::Operator::TaggedSymbol + ] + ) + end + def self.values end - def self.values; end end end @@ -273,7 +310,12 @@ module FinchAPI extend FinchAPI::Internal::Type::Enum TaggedSymbol = - T.type_alias { T.all(Symbol, FinchAPI::Models::HRIS::Company::PayStatementItem::RuleDeleteResponse::EntityType) } + T.type_alias do + T.all( + Symbol, + FinchAPI::Models::HRIS::Company::PayStatementItem::RuleDeleteResponse::EntityType + ) + end OrSymbol = T.type_alias { T.any(Symbol, String) } PAY_STATEMENT_ITEM = @@ -283,12 +325,14 @@ module FinchAPI ) sig do - override - .returns( - T::Array[FinchAPI::Models::HRIS::Company::PayStatementItem::RuleDeleteResponse::EntityType::TaggedSymbol] - ) + override.returns( + T::Array[ + FinchAPI::Models::HRIS::Company::PayStatementItem::RuleDeleteResponse::EntityType::TaggedSymbol + ] + ) + end + def self.values end - def self.values; end end end end diff --git a/rbi/finch_api/models/hris/company/pay_statement_item/rule_list_params.rbi b/rbi/finch_api/models/hris/company/pay_statement_item/rule_list_params.rbi index f85c6aae..fe6d2b94 100644 --- a/rbi/finch_api/models/hris/company/pay_statement_item/rule_list_params.rbi +++ b/rbi/finch_api/models/hris/company/pay_statement_item/rule_list_params.rbi @@ -9,14 +9,22 @@ module FinchAPI extend FinchAPI::Internal::Type::RequestParameters::Converter include FinchAPI::Internal::Type::RequestParameters + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + sig do - params(request_options: T.any(FinchAPI::RequestOptions, FinchAPI::Internal::AnyHash)) - .returns(T.attached_class) + params(request_options: FinchAPI::RequestOptions::OrHash).returns( + T.attached_class + ) + end + def self.new(request_options: {}) end - def self.new(request_options: {}); end - sig { override.returns({request_options: FinchAPI::RequestOptions}) } - def to_hash; end + sig do + override.returns({ request_options: FinchAPI::RequestOptions }) + end + def to_hash + end end end end diff --git a/rbi/finch_api/models/hris/company/pay_statement_item/rule_list_response.rbi b/rbi/finch_api/models/hris/company/pay_statement_item/rule_list_response.rbi index 2d129ac7..40fb4af0 100644 --- a/rbi/finch_api/models/hris/company/pay_statement_item/rule_list_response.rbi +++ b/rbi/finch_api/models/hris/company/pay_statement_item/rule_list_response.rbi @@ -6,6 +6,9 @@ module FinchAPI module Company module PayStatementItem class RuleListResponse < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + # Finch id (uuidv4) for the rule. sig { returns(T.nilable(String)) } attr_reader :id @@ -14,37 +17,41 @@ module FinchAPI attr_writer :id # Specifies the fields to be applied when the condition is met. - sig { returns(T.nilable(FinchAPI::Models::HRIS::Company::PayStatementItem::RuleListResponse::Attributes)) } + sig do + returns( + T.nilable( + FinchAPI::Models::HRIS::Company::PayStatementItem::RuleListResponse::Attributes + ) + ) + end attr_reader :attributes sig do params( - attributes: T.any( - FinchAPI::Models::HRIS::Company::PayStatementItem::RuleListResponse::Attributes, - FinchAPI::Internal::AnyHash - ) - ) - .void + attributes: + FinchAPI::Models::HRIS::Company::PayStatementItem::RuleListResponse::Attributes::OrHash + ).void end attr_writer :attributes sig do returns( - T.nilable(T::Array[FinchAPI::Models::HRIS::Company::PayStatementItem::RuleListResponse::Condition]) + T.nilable( + T::Array[ + FinchAPI::Models::HRIS::Company::PayStatementItem::RuleListResponse::Condition + ] + ) ) end attr_reader :conditions sig do params( - conditions: T::Array[ - T.any( - FinchAPI::Models::HRIS::Company::PayStatementItem::RuleListResponse::Condition, - FinchAPI::Internal::AnyHash - ) - ] - ) - .void + conditions: + T::Array[ + FinchAPI::Models::HRIS::Company::PayStatementItem::RuleListResponse::Condition::OrHash + ] + ).void end attr_writer :conditions @@ -66,16 +73,18 @@ module FinchAPI # The entity type to which the rule is applied. sig do returns( - T.nilable(FinchAPI::Models::HRIS::Company::PayStatementItem::RuleListResponse::EntityType::TaggedSymbol) + T.nilable( + FinchAPI::Models::HRIS::Company::PayStatementItem::RuleListResponse::EntityType::TaggedSymbol + ) ) end attr_reader :entity_type sig do params( - entity_type: FinchAPI::Models::HRIS::Company::PayStatementItem::RuleListResponse::EntityType::OrSymbol - ) - .void + entity_type: + FinchAPI::Models::HRIS::Company::PayStatementItem::RuleListResponse::EntityType::OrSymbol + ).void end attr_writer :entity_type @@ -96,24 +105,20 @@ module FinchAPI sig do params( id: String, - attributes: T.any( - FinchAPI::Models::HRIS::Company::PayStatementItem::RuleListResponse::Attributes, - FinchAPI::Internal::AnyHash - ), - conditions: T::Array[ - T.any( - FinchAPI::Models::HRIS::Company::PayStatementItem::RuleListResponse::Condition, - FinchAPI::Internal::AnyHash - ) - ], + attributes: + FinchAPI::Models::HRIS::Company::PayStatementItem::RuleListResponse::Attributes::OrHash, + conditions: + T::Array[ + FinchAPI::Models::HRIS::Company::PayStatementItem::RuleListResponse::Condition::OrHash + ], created_at: Time, effective_end_date: T.nilable(String), effective_start_date: T.nilable(String), - entity_type: FinchAPI::Models::HRIS::Company::PayStatementItem::RuleListResponse::EntityType::OrSymbol, + entity_type: + FinchAPI::Models::HRIS::Company::PayStatementItem::RuleListResponse::EntityType::OrSymbol, priority: Integer, updated_at: Time - ) - .returns(T.attached_class) + ).returns(T.attached_class) end def self.new( # Finch id (uuidv4) for the rule. @@ -133,26 +138,36 @@ module FinchAPI priority: nil, # The datetime when the rule was last updated. updated_at: nil - ); end + ) + end + sig do - override - .returns( - { - id: String, - attributes: FinchAPI::Models::HRIS::Company::PayStatementItem::RuleListResponse::Attributes, - conditions: T::Array[FinchAPI::Models::HRIS::Company::PayStatementItem::RuleListResponse::Condition], - created_at: Time, - effective_end_date: T.nilable(String), - effective_start_date: T.nilable(String), - entity_type: FinchAPI::Models::HRIS::Company::PayStatementItem::RuleListResponse::EntityType::TaggedSymbol, - priority: Integer, - updated_at: Time - } - ) + override.returns( + { + id: String, + attributes: + FinchAPI::Models::HRIS::Company::PayStatementItem::RuleListResponse::Attributes, + conditions: + T::Array[ + FinchAPI::Models::HRIS::Company::PayStatementItem::RuleListResponse::Condition + ], + created_at: Time, + effective_end_date: T.nilable(String), + effective_start_date: T.nilable(String), + entity_type: + FinchAPI::Models::HRIS::Company::PayStatementItem::RuleListResponse::EntityType::TaggedSymbol, + priority: Integer, + updated_at: Time + } + ) + end + def to_hash end - def to_hash; end class Attributes < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + # The metadata to be attached in the entity. 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])) } @@ -162,17 +177,29 @@ module FinchAPI attr_writer :metadata # Specifies the fields to be applied when the condition is met. - sig { params(metadata: T::Hash[Symbol, T.anything]).returns(T.attached_class) } + sig do + params(metadata: T::Hash[Symbol, T.anything]).returns( + T.attached_class + ) + end def self.new( # The metadata to be attached in the entity. It is a key-value pairs where the # values can be of any type (string, number, boolean, object, array, etc.). metadata: nil - ); end - sig { override.returns({metadata: T::Hash[Symbol, T.anything]}) } - def to_hash; end + ) + end + + sig do + override.returns({ metadata: T::Hash[Symbol, T.anything] }) + end + def to_hash + end end class Condition < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + # The field to be checked in the rule. sig { returns(T.nilable(String)) } attr_reader :field @@ -192,9 +219,9 @@ module FinchAPI sig do params( - operator: FinchAPI::Models::HRIS::Company::PayStatementItem::RuleListResponse::Condition::Operator::OrSymbol - ) - .void + operator: + FinchAPI::Models::HRIS::Company::PayStatementItem::RuleListResponse::Condition::Operator::OrSymbol + ).void end attr_writer :operator @@ -208,10 +235,10 @@ module FinchAPI sig do params( field: String, - operator: FinchAPI::Models::HRIS::Company::PayStatementItem::RuleListResponse::Condition::Operator::OrSymbol, + operator: + FinchAPI::Models::HRIS::Company::PayStatementItem::RuleListResponse::Condition::Operator::OrSymbol, value: String - ) - .returns(T.attached_class) + ).returns(T.attached_class) end def self.new( # The field to be checked in the rule. @@ -220,25 +247,33 @@ module FinchAPI operator: nil, # The value of the field to be checked in the rule. value: nil - ); end + ) + end + sig do - override - .returns( - { - field: String, - operator: FinchAPI::Models::HRIS::Company::PayStatementItem::RuleListResponse::Condition::Operator::TaggedSymbol, - value: String - } - ) + override.returns( + { + field: String, + operator: + FinchAPI::Models::HRIS::Company::PayStatementItem::RuleListResponse::Condition::Operator::TaggedSymbol, + value: String + } + ) + end + def to_hash end - def to_hash; end # The operator to be used in the rule. module Operator extend FinchAPI::Internal::Type::Enum TaggedSymbol = - T.type_alias { T.all(Symbol, FinchAPI::Models::HRIS::Company::PayStatementItem::RuleListResponse::Condition::Operator) } + T.type_alias do + T.all( + Symbol, + FinchAPI::Models::HRIS::Company::PayStatementItem::RuleListResponse::Condition::Operator + ) + end OrSymbol = T.type_alias { T.any(Symbol, String) } EQUALS = @@ -248,12 +283,14 @@ module FinchAPI ) sig do - override - .returns( - T::Array[FinchAPI::Models::HRIS::Company::PayStatementItem::RuleListResponse::Condition::Operator::TaggedSymbol] - ) + override.returns( + T::Array[ + FinchAPI::Models::HRIS::Company::PayStatementItem::RuleListResponse::Condition::Operator::TaggedSymbol + ] + ) + end + def self.values end - def self.values; end end end @@ -262,7 +299,12 @@ module FinchAPI extend FinchAPI::Internal::Type::Enum TaggedSymbol = - T.type_alias { T.all(Symbol, FinchAPI::Models::HRIS::Company::PayStatementItem::RuleListResponse::EntityType) } + T.type_alias do + T.all( + Symbol, + FinchAPI::Models::HRIS::Company::PayStatementItem::RuleListResponse::EntityType + ) + end OrSymbol = T.type_alias { T.any(Symbol, String) } PAY_STATEMENT_ITEM = @@ -272,12 +314,14 @@ module FinchAPI ) sig do - override - .returns( - T::Array[FinchAPI::Models::HRIS::Company::PayStatementItem::RuleListResponse::EntityType::TaggedSymbol] - ) + override.returns( + T::Array[ + FinchAPI::Models::HRIS::Company::PayStatementItem::RuleListResponse::EntityType::TaggedSymbol + ] + ) + end + def self.values end - def self.values; end end end end diff --git a/rbi/finch_api/models/hris/company/pay_statement_item/rule_update_params.rbi b/rbi/finch_api/models/hris/company/pay_statement_item/rule_update_params.rbi index c0f79c0b..47c522da 100644 --- a/rbi/finch_api/models/hris/company/pay_statement_item/rule_update_params.rbi +++ b/rbi/finch_api/models/hris/company/pay_statement_item/rule_update_params.rbi @@ -9,6 +9,9 @@ module FinchAPI extend FinchAPI::Internal::Type::RequestParameters::Converter include FinchAPI::Internal::Type::RequestParameters + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + sig { returns(T.nilable(T.anything)) } attr_reader :optional_property @@ -18,16 +21,22 @@ module FinchAPI sig do params( optional_property: T.anything, - request_options: T.any(FinchAPI::RequestOptions, FinchAPI::Internal::AnyHash) - ) - .returns(T.attached_class) + request_options: FinchAPI::RequestOptions::OrHash + ).returns(T.attached_class) + end + def self.new(optional_property: nil, request_options: {}) end - def self.new(optional_property: nil, request_options: {}); end sig do - override.returns({optional_property: T.anything, request_options: FinchAPI::RequestOptions}) + override.returns( + { + optional_property: T.anything, + request_options: FinchAPI::RequestOptions + } + ) + end + def to_hash end - def to_hash; end end end end diff --git a/rbi/finch_api/models/hris/company/pay_statement_item/rule_update_response.rbi b/rbi/finch_api/models/hris/company/pay_statement_item/rule_update_response.rbi index cfeb9adf..21989ed7 100644 --- a/rbi/finch_api/models/hris/company/pay_statement_item/rule_update_response.rbi +++ b/rbi/finch_api/models/hris/company/pay_statement_item/rule_update_response.rbi @@ -6,6 +6,9 @@ module FinchAPI module Company module PayStatementItem class RuleUpdateResponse < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + # Finch id (uuidv4) for the rule. sig { returns(T.nilable(String)) } attr_reader :id @@ -14,37 +17,41 @@ module FinchAPI attr_writer :id # Specifies the fields to be applied when the condition is met. - sig { returns(T.nilable(FinchAPI::Models::HRIS::Company::PayStatementItem::RuleUpdateResponse::Attributes)) } + sig do + returns( + T.nilable( + FinchAPI::Models::HRIS::Company::PayStatementItem::RuleUpdateResponse::Attributes + ) + ) + end attr_reader :attributes sig do params( - attributes: T.any( - FinchAPI::Models::HRIS::Company::PayStatementItem::RuleUpdateResponse::Attributes, - FinchAPI::Internal::AnyHash - ) - ) - .void + attributes: + FinchAPI::Models::HRIS::Company::PayStatementItem::RuleUpdateResponse::Attributes::OrHash + ).void end attr_writer :attributes sig do returns( - T.nilable(T::Array[FinchAPI::Models::HRIS::Company::PayStatementItem::RuleUpdateResponse::Condition]) + T.nilable( + T::Array[ + FinchAPI::Models::HRIS::Company::PayStatementItem::RuleUpdateResponse::Condition + ] + ) ) end attr_reader :conditions sig do params( - conditions: T::Array[ - T.any( - FinchAPI::Models::HRIS::Company::PayStatementItem::RuleUpdateResponse::Condition, - FinchAPI::Internal::AnyHash - ) - ] - ) - .void + conditions: + T::Array[ + FinchAPI::Models::HRIS::Company::PayStatementItem::RuleUpdateResponse::Condition::OrHash + ] + ).void end attr_writer :conditions @@ -66,16 +73,18 @@ module FinchAPI # The entity type to which the rule is applied. sig do returns( - T.nilable(FinchAPI::Models::HRIS::Company::PayStatementItem::RuleUpdateResponse::EntityType::TaggedSymbol) + T.nilable( + FinchAPI::Models::HRIS::Company::PayStatementItem::RuleUpdateResponse::EntityType::TaggedSymbol + ) ) end attr_reader :entity_type sig do params( - entity_type: FinchAPI::Models::HRIS::Company::PayStatementItem::RuleUpdateResponse::EntityType::OrSymbol - ) - .void + entity_type: + FinchAPI::Models::HRIS::Company::PayStatementItem::RuleUpdateResponse::EntityType::OrSymbol + ).void end attr_writer :entity_type @@ -96,24 +105,20 @@ module FinchAPI sig do params( id: String, - attributes: T.any( - FinchAPI::Models::HRIS::Company::PayStatementItem::RuleUpdateResponse::Attributes, - FinchAPI::Internal::AnyHash - ), - conditions: T::Array[ - T.any( - FinchAPI::Models::HRIS::Company::PayStatementItem::RuleUpdateResponse::Condition, - FinchAPI::Internal::AnyHash - ) - ], + attributes: + FinchAPI::Models::HRIS::Company::PayStatementItem::RuleUpdateResponse::Attributes::OrHash, + conditions: + T::Array[ + FinchAPI::Models::HRIS::Company::PayStatementItem::RuleUpdateResponse::Condition::OrHash + ], created_at: Time, effective_end_date: T.nilable(String), effective_start_date: T.nilable(String), - entity_type: FinchAPI::Models::HRIS::Company::PayStatementItem::RuleUpdateResponse::EntityType::OrSymbol, + entity_type: + FinchAPI::Models::HRIS::Company::PayStatementItem::RuleUpdateResponse::EntityType::OrSymbol, priority: Integer, updated_at: Time - ) - .returns(T.attached_class) + ).returns(T.attached_class) end def self.new( # Finch id (uuidv4) for the rule. @@ -133,26 +138,36 @@ module FinchAPI priority: nil, # The datetime when the rule was last updated. updated_at: nil - ); end + ) + end + sig do - override - .returns( - { - id: String, - attributes: FinchAPI::Models::HRIS::Company::PayStatementItem::RuleUpdateResponse::Attributes, - conditions: T::Array[FinchAPI::Models::HRIS::Company::PayStatementItem::RuleUpdateResponse::Condition], - created_at: Time, - effective_end_date: T.nilable(String), - effective_start_date: T.nilable(String), - entity_type: FinchAPI::Models::HRIS::Company::PayStatementItem::RuleUpdateResponse::EntityType::TaggedSymbol, - priority: Integer, - updated_at: Time - } - ) + override.returns( + { + id: String, + attributes: + FinchAPI::Models::HRIS::Company::PayStatementItem::RuleUpdateResponse::Attributes, + conditions: + T::Array[ + FinchAPI::Models::HRIS::Company::PayStatementItem::RuleUpdateResponse::Condition + ], + created_at: Time, + effective_end_date: T.nilable(String), + effective_start_date: T.nilable(String), + entity_type: + FinchAPI::Models::HRIS::Company::PayStatementItem::RuleUpdateResponse::EntityType::TaggedSymbol, + priority: Integer, + updated_at: Time + } + ) + end + def to_hash end - def to_hash; end class Attributes < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + # The metadata to be attached in the entity. 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])) } @@ -162,17 +177,29 @@ module FinchAPI attr_writer :metadata # Specifies the fields to be applied when the condition is met. - sig { params(metadata: T::Hash[Symbol, T.anything]).returns(T.attached_class) } + sig do + params(metadata: T::Hash[Symbol, T.anything]).returns( + T.attached_class + ) + end def self.new( # The metadata to be attached in the entity. It is a key-value pairs where the # values can be of any type (string, number, boolean, object, array, etc.). metadata: nil - ); end - sig { override.returns({metadata: T::Hash[Symbol, T.anything]}) } - def to_hash; end + ) + end + + sig do + override.returns({ metadata: T::Hash[Symbol, T.anything] }) + end + def to_hash + end end class Condition < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + # The field to be checked in the rule. sig { returns(T.nilable(String)) } attr_reader :field @@ -192,9 +219,9 @@ module FinchAPI sig do params( - operator: FinchAPI::Models::HRIS::Company::PayStatementItem::RuleUpdateResponse::Condition::Operator::OrSymbol - ) - .void + operator: + FinchAPI::Models::HRIS::Company::PayStatementItem::RuleUpdateResponse::Condition::Operator::OrSymbol + ).void end attr_writer :operator @@ -208,10 +235,10 @@ module FinchAPI sig do params( field: String, - operator: FinchAPI::Models::HRIS::Company::PayStatementItem::RuleUpdateResponse::Condition::Operator::OrSymbol, + operator: + FinchAPI::Models::HRIS::Company::PayStatementItem::RuleUpdateResponse::Condition::Operator::OrSymbol, value: String - ) - .returns(T.attached_class) + ).returns(T.attached_class) end def self.new( # The field to be checked in the rule. @@ -220,25 +247,33 @@ module FinchAPI operator: nil, # The value of the field to be checked in the rule. value: nil - ); end + ) + end + sig do - override - .returns( - { - field: String, - operator: FinchAPI::Models::HRIS::Company::PayStatementItem::RuleUpdateResponse::Condition::Operator::TaggedSymbol, - value: String - } - ) + override.returns( + { + field: String, + operator: + FinchAPI::Models::HRIS::Company::PayStatementItem::RuleUpdateResponse::Condition::Operator::TaggedSymbol, + value: String + } + ) + end + def to_hash end - def to_hash; end # The operator to be used in the rule. module Operator extend FinchAPI::Internal::Type::Enum TaggedSymbol = - T.type_alias { T.all(Symbol, FinchAPI::Models::HRIS::Company::PayStatementItem::RuleUpdateResponse::Condition::Operator) } + T.type_alias do + T.all( + Symbol, + FinchAPI::Models::HRIS::Company::PayStatementItem::RuleUpdateResponse::Condition::Operator + ) + end OrSymbol = T.type_alias { T.any(Symbol, String) } EQUALS = @@ -248,12 +283,14 @@ module FinchAPI ) sig do - override - .returns( - T::Array[FinchAPI::Models::HRIS::Company::PayStatementItem::RuleUpdateResponse::Condition::Operator::TaggedSymbol] - ) + override.returns( + T::Array[ + FinchAPI::Models::HRIS::Company::PayStatementItem::RuleUpdateResponse::Condition::Operator::TaggedSymbol + ] + ) + end + def self.values end - def self.values; end end end @@ -262,7 +299,12 @@ module FinchAPI extend FinchAPI::Internal::Type::Enum TaggedSymbol = - T.type_alias { T.all(Symbol, FinchAPI::Models::HRIS::Company::PayStatementItem::RuleUpdateResponse::EntityType) } + T.type_alias do + T.all( + Symbol, + FinchAPI::Models::HRIS::Company::PayStatementItem::RuleUpdateResponse::EntityType + ) + end OrSymbol = T.type_alias { T.any(Symbol, String) } PAY_STATEMENT_ITEM = @@ -272,12 +314,14 @@ module FinchAPI ) sig do - override - .returns( - T::Array[FinchAPI::Models::HRIS::Company::PayStatementItem::RuleUpdateResponse::EntityType::TaggedSymbol] - ) + override.returns( + T::Array[ + FinchAPI::Models::HRIS::Company::PayStatementItem::RuleUpdateResponse::EntityType::TaggedSymbol + ] + ) + end + def self.values end - def self.values; end end end end diff --git a/rbi/finch_api/models/hris/company/pay_statement_item_list_params.rbi b/rbi/finch_api/models/hris/company/pay_statement_item_list_params.rbi index 9a55e783..e6e94f94 100644 --- a/rbi/finch_api/models/hris/company/pay_statement_item_list_params.rbi +++ b/rbi/finch_api/models/hris/company/pay_statement_item_list_params.rbi @@ -8,20 +8,29 @@ module FinchAPI extend FinchAPI::Internal::Type::RequestParameters::Converter include FinchAPI::Internal::Type::RequestParameters + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + # Comma-delimited list of pay statement item categories to filter on. If empty, # defaults to all categories. sig do returns( - T.nilable(T::Array[FinchAPI::Models::HRIS::Company::PayStatementItemListParams::Category::OrSymbol]) + T.nilable( + T::Array[ + FinchAPI::HRIS::Company::PayStatementItemListParams::Category::OrSymbol + ] + ) ) end attr_reader :categories sig do params( - categories: T::Array[FinchAPI::Models::HRIS::Company::PayStatementItemListParams::Category::OrSymbol] - ) - .void + categories: + T::Array[ + FinchAPI::HRIS::Company::PayStatementItemListParams::Category::OrSymbol + ] + ).void end attr_writer :categories @@ -57,14 +66,16 @@ module FinchAPI sig do params( - categories: T::Array[FinchAPI::Models::HRIS::Company::PayStatementItemListParams::Category::OrSymbol], + categories: + T::Array[ + FinchAPI::HRIS::Company::PayStatementItemListParams::Category::OrSymbol + ], end_date: Date, name: String, start_date: Date, type: String, - request_options: T.any(FinchAPI::RequestOptions, FinchAPI::Internal::AnyHash) - ) - .returns(T.attached_class) + request_options: FinchAPI::RequestOptions::OrHash + ).returns(T.attached_class) end def self.new( # Comma-delimited list of pay statement item categories to filter on. If empty, @@ -81,49 +92,69 @@ module FinchAPI # String search by pay statement item type. type: nil, request_options: {} - ); end + ) + end + sig do - override - .returns( - { - categories: T::Array[FinchAPI::Models::HRIS::Company::PayStatementItemListParams::Category::OrSymbol], - end_date: Date, - name: String, - start_date: Date, - type: String, - request_options: FinchAPI::RequestOptions - } - ) + override.returns( + { + categories: + T::Array[ + FinchAPI::HRIS::Company::PayStatementItemListParams::Category::OrSymbol + ], + end_date: Date, + name: String, + start_date: Date, + type: String, + request_options: FinchAPI::RequestOptions + } + ) + end + def to_hash end - def to_hash; end module Category extend FinchAPI::Internal::Type::Enum TaggedSymbol = - T.type_alias { T.all(Symbol, FinchAPI::Models::HRIS::Company::PayStatementItemListParams::Category) } + T.type_alias do + T.all( + Symbol, + FinchAPI::HRIS::Company::PayStatementItemListParams::Category + ) + end OrSymbol = T.type_alias { T.any(Symbol, String) } EARNINGS = - T.let(:earnings, FinchAPI::Models::HRIS::Company::PayStatementItemListParams::Category::TaggedSymbol) + T.let( + :earnings, + FinchAPI::HRIS::Company::PayStatementItemListParams::Category::TaggedSymbol + ) TAXES = - T.let(:taxes, FinchAPI::Models::HRIS::Company::PayStatementItemListParams::Category::TaggedSymbol) + T.let( + :taxes, + FinchAPI::HRIS::Company::PayStatementItemListParams::Category::TaggedSymbol + ) EMPLOYEE_DEDUCTIONS = T.let( :employee_deductions, - FinchAPI::Models::HRIS::Company::PayStatementItemListParams::Category::TaggedSymbol + FinchAPI::HRIS::Company::PayStatementItemListParams::Category::TaggedSymbol ) EMPLOYER_CONTRIBUTIONS = T.let( :employer_contributions, - FinchAPI::Models::HRIS::Company::PayStatementItemListParams::Category::TaggedSymbol + FinchAPI::HRIS::Company::PayStatementItemListParams::Category::TaggedSymbol ) sig do - override - .returns(T::Array[FinchAPI::Models::HRIS::Company::PayStatementItemListParams::Category::TaggedSymbol]) + override.returns( + T::Array[ + FinchAPI::HRIS::Company::PayStatementItemListParams::Category::TaggedSymbol + ] + ) + end + def self.values end - def self.values; end end end end diff --git a/rbi/finch_api/models/hris/company/pay_statement_item_list_response.rbi b/rbi/finch_api/models/hris/company/pay_statement_item_list_response.rbi index 88ca704a..fe8b20dc 100644 --- a/rbi/finch_api/models/hris/company/pay_statement_item_list_response.rbi +++ b/rbi/finch_api/models/hris/company/pay_statement_item_list_response.rbi @@ -5,26 +5,43 @@ module FinchAPI module HRIS module Company class PayStatementItemListResponse < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + # The attributes of the pay statement item. - sig { returns(T.nilable(FinchAPI::Models::HRIS::Company::PayStatementItemListResponse::Attributes)) } + sig do + returns( + T.nilable( + FinchAPI::Models::HRIS::Company::PayStatementItemListResponse::Attributes + ) + ) + end attr_reader :attributes sig do params( - attributes: T.any( - FinchAPI::Models::HRIS::Company::PayStatementItemListResponse::Attributes, - FinchAPI::Internal::AnyHash - ) - ) - .void + attributes: + FinchAPI::Models::HRIS::Company::PayStatementItemListResponse::Attributes::OrHash + ).void end attr_writer :attributes # The category of the pay statement item. - sig { returns(T.nilable(FinchAPI::Models::HRIS::Company::PayStatementItemListResponse::Category::TaggedSymbol)) } + sig do + returns( + T.nilable( + FinchAPI::Models::HRIS::Company::PayStatementItemListResponse::Category::TaggedSymbol + ) + ) + end attr_reader :category - sig { params(category: FinchAPI::Models::HRIS::Company::PayStatementItemListResponse::Category::OrSymbol).void } + sig do + params( + category: + FinchAPI::Models::HRIS::Company::PayStatementItemListResponse::Category::OrSymbol + ).void + end attr_writer :category # The name of the pay statement item. @@ -36,14 +53,12 @@ module FinchAPI sig do params( - attributes: T.any( - FinchAPI::Models::HRIS::Company::PayStatementItemListResponse::Attributes, - FinchAPI::Internal::AnyHash - ), - category: FinchAPI::Models::HRIS::Company::PayStatementItemListResponse::Category::OrSymbol, + attributes: + FinchAPI::Models::HRIS::Company::PayStatementItemListResponse::Attributes::OrHash, + category: + FinchAPI::Models::HRIS::Company::PayStatementItemListResponse::Category::OrSymbol, name: String - ) - .returns(T.attached_class) + ).returns(T.attached_class) end def self.new( # The attributes of the pay statement item. @@ -52,20 +67,27 @@ module FinchAPI category: nil, # The name of the pay statement item. name: nil - ); end + ) + end + sig do - override - .returns( - { - attributes: FinchAPI::Models::HRIS::Company::PayStatementItemListResponse::Attributes, - category: FinchAPI::Models::HRIS::Company::PayStatementItemListResponse::Category::TaggedSymbol, - name: String - } - ) + override.returns( + { + attributes: + FinchAPI::Models::HRIS::Company::PayStatementItemListResponse::Attributes, + category: + FinchAPI::Models::HRIS::Company::PayStatementItemListResponse::Category::TaggedSymbol, + name: String + } + ) + end + def to_hash end - def to_hash; end class Attributes < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + # `true` if the amount is paid by the employers. This field is only available for # taxes. sig { returns(T.nilable(T::Boolean)) } @@ -92,8 +114,7 @@ module FinchAPI metadata: T.nilable(T::Hash[Symbol, T.nilable(T.anything)]), pre_tax: T.nilable(T::Boolean), type: T.nilable(String) - ) - .returns(T.attached_class) + ).returns(T.attached_class) end def self.new( # `true` if the amount is paid by the employers. This field is only available for @@ -107,19 +128,21 @@ module FinchAPI pre_tax: nil, # The type of the pay statement item. type: nil - ); end + ) + end + sig do - override - .returns( - { - employer: T.nilable(T::Boolean), - metadata: T.nilable(T::Hash[Symbol, T.nilable(T.anything)]), - pre_tax: T.nilable(T::Boolean), - type: T.nilable(String) - } - ) + override.returns( + { + employer: T.nilable(T::Boolean), + metadata: T.nilable(T::Hash[Symbol, T.nilable(T.anything)]), + pre_tax: T.nilable(T::Boolean), + type: T.nilable(String) + } + ) + end + def to_hash end - def to_hash; end end # The category of the pay statement item. @@ -127,13 +150,24 @@ module FinchAPI extend FinchAPI::Internal::Type::Enum TaggedSymbol = - T.type_alias { T.all(Symbol, FinchAPI::Models::HRIS::Company::PayStatementItemListResponse::Category) } + T.type_alias do + T.all( + Symbol, + FinchAPI::Models::HRIS::Company::PayStatementItemListResponse::Category + ) + end OrSymbol = T.type_alias { T.any(Symbol, String) } EARNINGS = - T.let(:earnings, FinchAPI::Models::HRIS::Company::PayStatementItemListResponse::Category::TaggedSymbol) + T.let( + :earnings, + FinchAPI::Models::HRIS::Company::PayStatementItemListResponse::Category::TaggedSymbol + ) TAXES = - T.let(:taxes, FinchAPI::Models::HRIS::Company::PayStatementItemListResponse::Category::TaggedSymbol) + T.let( + :taxes, + FinchAPI::Models::HRIS::Company::PayStatementItemListResponse::Category::TaggedSymbol + ) EMPLOYEE_DEDUCTIONS = T.let( :employee_deductions, @@ -146,10 +180,14 @@ module FinchAPI ) sig do - override - .returns(T::Array[FinchAPI::Models::HRIS::Company::PayStatementItemListResponse::Category::TaggedSymbol]) + override.returns( + T::Array[ + FinchAPI::Models::HRIS::Company::PayStatementItemListResponse::Category::TaggedSymbol + ] + ) + end + def self.values end - def self.values; end end end end diff --git a/rbi/finch_api/models/hris/company_benefit.rbi b/rbi/finch_api/models/hris/company_benefit.rbi index b8391fa1..f3c8d308 100644 --- a/rbi/finch_api/models/hris/company_benefit.rbi +++ b/rbi/finch_api/models/hris/company_benefit.rbi @@ -4,19 +4,28 @@ module FinchAPI module Models module HRIS class CompanyBenefit < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + # The id of the benefit. sig { returns(String) } attr_accessor :benefit_id # The company match for this benefit. - sig { returns(T.nilable(FinchAPI::Models::HRIS::CompanyBenefit::CompanyContribution)) } + sig do + returns( + T.nilable(FinchAPI::HRIS::CompanyBenefit::CompanyContribution) + ) + end attr_reader :company_contribution sig do params( - company_contribution: T.nilable(T.any(FinchAPI::Models::HRIS::CompanyBenefit::CompanyContribution, FinchAPI::Internal::AnyHash)) - ) - .void + company_contribution: + T.nilable( + FinchAPI::HRIS::CompanyBenefit::CompanyContribution::OrHash + ) + ).void end attr_writer :company_contribution @@ -24,22 +33,26 @@ module FinchAPI attr_accessor :description # The frequency of the benefit deduction/contribution. - sig { returns(T.nilable(FinchAPI::Models::HRIS::BenefitFrequency::TaggedSymbol)) } + sig do + returns(T.nilable(FinchAPI::HRIS::BenefitFrequency::TaggedSymbol)) + end attr_accessor :frequency # Type of benefit. - sig { returns(T.nilable(FinchAPI::Models::HRIS::BenefitType::TaggedSymbol)) } + sig { returns(T.nilable(FinchAPI::HRIS::BenefitType::TaggedSymbol)) } attr_accessor :type sig do params( benefit_id: String, - company_contribution: T.nilable(T.any(FinchAPI::Models::HRIS::CompanyBenefit::CompanyContribution, FinchAPI::Internal::AnyHash)), + company_contribution: + T.nilable( + FinchAPI::HRIS::CompanyBenefit::CompanyContribution::OrHash + ), description: T.nilable(String), - frequency: T.nilable(FinchAPI::Models::HRIS::BenefitFrequency::OrSymbol), - type: T.nilable(FinchAPI::Models::HRIS::BenefitType::OrSymbol) - ) - .returns(T.attached_class) + frequency: T.nilable(FinchAPI::HRIS::BenefitFrequency::OrSymbol), + type: T.nilable(FinchAPI::HRIS::BenefitType::OrSymbol) + ).returns(T.attached_class) end def self.new( # The id of the benefit. @@ -51,61 +64,100 @@ module FinchAPI frequency:, # Type of benefit. type: - ); end + ) + end + sig do - override - .returns( - { - benefit_id: String, - company_contribution: T.nilable(FinchAPI::Models::HRIS::CompanyBenefit::CompanyContribution), - description: T.nilable(String), - frequency: T.nilable(FinchAPI::Models::HRIS::BenefitFrequency::TaggedSymbol), - type: T.nilable(FinchAPI::Models::HRIS::BenefitType::TaggedSymbol) - } - ) + override.returns( + { + benefit_id: String, + company_contribution: + T.nilable(FinchAPI::HRIS::CompanyBenefit::CompanyContribution), + description: T.nilable(String), + frequency: + T.nilable(FinchAPI::HRIS::BenefitFrequency::TaggedSymbol), + type: T.nilable(FinchAPI::HRIS::BenefitType::TaggedSymbol) + } + ) + end + def to_hash end - def to_hash; end class CompanyContribution < FinchAPI::Internal::Type::BaseModel - sig { returns(T.nilable(T::Array[FinchAPI::Models::HRIS::CompanyBenefit::CompanyContribution::Tier])) } + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + + sig do + returns( + T.nilable( + T::Array[ + FinchAPI::HRIS::CompanyBenefit::CompanyContribution::Tier + ] + ) + ) + end attr_reader :tiers sig do params( - tiers: T::Array[T.any(FinchAPI::Models::HRIS::CompanyBenefit::CompanyContribution::Tier, FinchAPI::Internal::AnyHash)] - ) - .void + tiers: + T::Array[ + FinchAPI::HRIS::CompanyBenefit::CompanyContribution::Tier::OrHash + ] + ).void end attr_writer :tiers - sig { returns(T.nilable(FinchAPI::Models::HRIS::CompanyBenefit::CompanyContribution::Type::TaggedSymbol)) } + sig do + returns( + T.nilable( + FinchAPI::HRIS::CompanyBenefit::CompanyContribution::Type::TaggedSymbol + ) + ) + end attr_reader :type - sig { params(type: FinchAPI::Models::HRIS::CompanyBenefit::CompanyContribution::Type::OrSymbol).void } + sig do + params( + type: + FinchAPI::HRIS::CompanyBenefit::CompanyContribution::Type::OrSymbol + ).void + end attr_writer :type # The company match for this benefit. sig do params( - tiers: T::Array[T.any(FinchAPI::Models::HRIS::CompanyBenefit::CompanyContribution::Tier, FinchAPI::Internal::AnyHash)], - type: FinchAPI::Models::HRIS::CompanyBenefit::CompanyContribution::Type::OrSymbol - ) - .returns(T.attached_class) + tiers: + T::Array[ + FinchAPI::HRIS::CompanyBenefit::CompanyContribution::Tier::OrHash + ], + type: + FinchAPI::HRIS::CompanyBenefit::CompanyContribution::Type::OrSymbol + ).returns(T.attached_class) + end + def self.new(tiers: nil, type: nil) end - def self.new(tiers: nil, type: nil); end sig do - override - .returns( - { - tiers: T::Array[FinchAPI::Models::HRIS::CompanyBenefit::CompanyContribution::Tier], - type: FinchAPI::Models::HRIS::CompanyBenefit::CompanyContribution::Type::TaggedSymbol - } - ) + override.returns( + { + tiers: + T::Array[ + FinchAPI::HRIS::CompanyBenefit::CompanyContribution::Tier + ], + type: + FinchAPI::HRIS::CompanyBenefit::CompanyContribution::Type::TaggedSymbol + } + ) + end + def to_hash end - def to_hash; end class Tier < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + sig { returns(T.nilable(Integer)) } attr_reader :match @@ -118,26 +170,46 @@ module FinchAPI sig { params(threshold: Integer).void } attr_writer :threshold - sig { params(match: Integer, threshold: Integer).returns(T.attached_class) } - def self.new(match: nil, threshold: nil); end + sig do + params(match: Integer, threshold: Integer).returns( + T.attached_class + ) + end + def self.new(match: nil, threshold: nil) + end - sig { override.returns({match: Integer, threshold: Integer}) } - def to_hash; end + sig { override.returns({ match: Integer, threshold: Integer }) } + def to_hash + end end module Type extend FinchAPI::Internal::Type::Enum TaggedSymbol = - T.type_alias { T.all(Symbol, FinchAPI::Models::HRIS::CompanyBenefit::CompanyContribution::Type) } + T.type_alias do + T.all( + Symbol, + FinchAPI::HRIS::CompanyBenefit::CompanyContribution::Type + ) + end OrSymbol = T.type_alias { T.any(Symbol, String) } - MATCH = T.let(:match, FinchAPI::Models::HRIS::CompanyBenefit::CompanyContribution::Type::TaggedSymbol) + MATCH = + T.let( + :match, + FinchAPI::HRIS::CompanyBenefit::CompanyContribution::Type::TaggedSymbol + ) sig do - override.returns(T::Array[FinchAPI::Models::HRIS::CompanyBenefit::CompanyContribution::Type::TaggedSymbol]) + override.returns( + T::Array[ + FinchAPI::HRIS::CompanyBenefit::CompanyContribution::Type::TaggedSymbol + ] + ) + end + def self.values end - def self.values; end end end end diff --git a/rbi/finch_api/models/hris/company_retrieve_params.rbi b/rbi/finch_api/models/hris/company_retrieve_params.rbi index 9f1c422f..7b6103dd 100644 --- a/rbi/finch_api/models/hris/company_retrieve_params.rbi +++ b/rbi/finch_api/models/hris/company_retrieve_params.rbi @@ -7,14 +7,20 @@ module FinchAPI extend FinchAPI::Internal::Type::RequestParameters::Converter include FinchAPI::Internal::Type::RequestParameters + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + sig do - params(request_options: T.any(FinchAPI::RequestOptions, FinchAPI::Internal::AnyHash)) - .returns(T.attached_class) + params(request_options: FinchAPI::RequestOptions::OrHash).returns( + T.attached_class + ) + end + def self.new(request_options: {}) end - def self.new(request_options: {}); end - sig { override.returns({request_options: FinchAPI::RequestOptions}) } - def to_hash; end + sig { override.returns({ request_options: FinchAPI::RequestOptions }) } + def to_hash + end end end end diff --git a/rbi/finch_api/models/hris/create_company_benefits_response.rbi b/rbi/finch_api/models/hris/create_company_benefits_response.rbi index c25b617a..8c1171de 100644 --- a/rbi/finch_api/models/hris/create_company_benefits_response.rbi +++ b/rbi/finch_api/models/hris/create_company_benefits_response.rbi @@ -4,6 +4,9 @@ module FinchAPI module Models module HRIS class CreateCompanyBenefitsResponse < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + # The id of the benefit. sig { returns(String) } attr_accessor :benefit_id @@ -11,14 +14,19 @@ module FinchAPI sig { returns(String) } attr_accessor :job_id - sig { params(benefit_id: String, job_id: String).returns(T.attached_class) } + sig do + params(benefit_id: String, job_id: String).returns(T.attached_class) + end def self.new( # The id of the benefit. benefit_id:, job_id: - ); end - sig { override.returns({benefit_id: String, job_id: String}) } - def to_hash; end + ) + end + + sig { override.returns({ benefit_id: String, job_id: String }) } + def to_hash + end end end end diff --git a/rbi/finch_api/models/hris/directory_list_individuals_params.rbi b/rbi/finch_api/models/hris/directory_list_individuals_params.rbi index aaae2515..6a97d740 100644 --- a/rbi/finch_api/models/hris/directory_list_individuals_params.rbi +++ b/rbi/finch_api/models/hris/directory_list_individuals_params.rbi @@ -7,6 +7,9 @@ module FinchAPI extend FinchAPI::Internal::Type::RequestParameters::Converter include FinchAPI::Internal::Type::RequestParameters + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + # Number of employees to return (defaults to all) sig { returns(T.nilable(Integer)) } attr_reader :limit @@ -25,9 +28,8 @@ module FinchAPI params( limit: Integer, offset: Integer, - request_options: T.any(FinchAPI::RequestOptions, FinchAPI::Internal::AnyHash) - ) - .returns(T.attached_class) + request_options: FinchAPI::RequestOptions::OrHash + ).returns(T.attached_class) end def self.new( # Number of employees to return (defaults to all) @@ -35,9 +37,20 @@ module FinchAPI # Index to start from (defaults to 0) offset: nil, request_options: {} - ); end - sig { override.returns({limit: Integer, offset: Integer, request_options: FinchAPI::RequestOptions}) } - def to_hash; end + ) + end + + sig do + override.returns( + { + limit: Integer, + offset: Integer, + request_options: FinchAPI::RequestOptions + } + ) + end + def to_hash + end end end end diff --git a/rbi/finch_api/models/hris/directory_list_params.rbi b/rbi/finch_api/models/hris/directory_list_params.rbi index c3140167..485972c9 100644 --- a/rbi/finch_api/models/hris/directory_list_params.rbi +++ b/rbi/finch_api/models/hris/directory_list_params.rbi @@ -7,6 +7,9 @@ module FinchAPI extend FinchAPI::Internal::Type::RequestParameters::Converter include FinchAPI::Internal::Type::RequestParameters + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + # Number of employees to return (defaults to all) sig { returns(T.nilable(Integer)) } attr_reader :limit @@ -25,9 +28,8 @@ module FinchAPI params( limit: Integer, offset: Integer, - request_options: T.any(FinchAPI::RequestOptions, FinchAPI::Internal::AnyHash) - ) - .returns(T.attached_class) + request_options: FinchAPI::RequestOptions::OrHash + ).returns(T.attached_class) end def self.new( # Number of employees to return (defaults to all) @@ -35,9 +37,20 @@ module FinchAPI # Index to start from (defaults to 0) offset: nil, request_options: {} - ); end - sig { override.returns({limit: Integer, offset: Integer, request_options: FinchAPI::RequestOptions}) } - def to_hash; end + ) + end + + sig do + override.returns( + { + limit: Integer, + offset: Integer, + request_options: FinchAPI::RequestOptions + } + ) + end + def to_hash + end end end end diff --git a/rbi/finch_api/models/hris/document_list_params.rbi b/rbi/finch_api/models/hris/document_list_params.rbi index d72a7487..e63364f2 100644 --- a/rbi/finch_api/models/hris/document_list_params.rbi +++ b/rbi/finch_api/models/hris/document_list_params.rbi @@ -7,6 +7,9 @@ module FinchAPI extend FinchAPI::Internal::Type::RequestParameters::Converter include FinchAPI::Internal::Type::RequestParameters + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + # Comma-delimited list of stable Finch uuids for each individual. If empty, # defaults to all individuals sig { returns(T.nilable(T::Array[String])) } @@ -31,10 +34,20 @@ module FinchAPI # 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])) } + sig do + returns( + T.nilable( + T::Array[FinchAPI::HRIS::DocumentListParams::Type::OrSymbol] + ) + ) + end attr_reader :types - sig { params(types: T::Array[FinchAPI::Models::HRIS::DocumentListParams::Type::OrSymbol]).void } + sig do + params( + types: T::Array[FinchAPI::HRIS::DocumentListParams::Type::OrSymbol] + ).void + end attr_writer :types sig do @@ -42,10 +55,9 @@ module FinchAPI individual_ids: T::Array[String], limit: Integer, offset: Integer, - types: T::Array[FinchAPI::Models::HRIS::DocumentListParams::Type::OrSymbol], - request_options: T.any(FinchAPI::RequestOptions, FinchAPI::Internal::AnyHash) - ) - .returns(T.attached_class) + types: T::Array[FinchAPI::HRIS::DocumentListParams::Type::OrSymbol], + request_options: FinchAPI::RequestOptions::OrHash + ).returns(T.attached_class) end def self.new( # Comma-delimited list of stable Finch uuids for each individual. If empty, @@ -59,32 +71,51 @@ module FinchAPI # types types: nil, request_options: {} - ); end + ) + end + sig do - override - .returns( - { - individual_ids: T::Array[String], - limit: Integer, - offset: Integer, - types: T::Array[FinchAPI::Models::HRIS::DocumentListParams::Type::OrSymbol], - request_options: FinchAPI::RequestOptions - } - ) + override.returns( + { + individual_ids: T::Array[String], + limit: Integer, + offset: Integer, + types: + T::Array[FinchAPI::HRIS::DocumentListParams::Type::OrSymbol], + request_options: FinchAPI::RequestOptions + } + ) + end + def to_hash end - def to_hash; end module Type extend FinchAPI::Internal::Type::Enum - TaggedSymbol = T.type_alias { T.all(Symbol, FinchAPI::Models::HRIS::DocumentListParams::Type) } + TaggedSymbol = + T.type_alias do + T.all(Symbol, FinchAPI::HRIS::DocumentListParams::Type) + end OrSymbol = T.type_alias { T.any(Symbol, String) } - W4_2020 = T.let(:w4_2020, FinchAPI::Models::HRIS::DocumentListParams::Type::TaggedSymbol) - W4_2005 = T.let(:w4_2005, FinchAPI::Models::HRIS::DocumentListParams::Type::TaggedSymbol) + W4_2020 = + T.let( + :w4_2020, + FinchAPI::HRIS::DocumentListParams::Type::TaggedSymbol + ) + W4_2005 = + T.let( + :w4_2005, + FinchAPI::HRIS::DocumentListParams::Type::TaggedSymbol + ) - sig { override.returns(T::Array[FinchAPI::Models::HRIS::DocumentListParams::Type::TaggedSymbol]) } - def self.values; end + sig do + override.returns( + T::Array[FinchAPI::HRIS::DocumentListParams::Type::TaggedSymbol] + ) + end + def self.values + end end end end diff --git a/rbi/finch_api/models/hris/document_list_response.rbi b/rbi/finch_api/models/hris/document_list_response.rbi index f097ba01..60673a7c 100644 --- a/rbi/finch_api/models/hris/document_list_response.rbi +++ b/rbi/finch_api/models/hris/document_list_response.rbi @@ -4,29 +4,37 @@ module FinchAPI module Models module HRIS class DocumentListResponse < FinchAPI::Internal::Type::BaseModel - sig { returns(T::Array[FinchAPI::Models::HRIS::DocumentResponse]) } + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + + sig { returns(T::Array[FinchAPI::HRIS::DocumentResponse]) } attr_accessor :documents - sig { returns(FinchAPI::Models::Paging) } + sig { returns(FinchAPI::Paging) } attr_reader :paging - sig { params(paging: T.any(FinchAPI::Models::Paging, FinchAPI::Internal::AnyHash)).void } + sig { params(paging: FinchAPI::Paging::OrHash).void } attr_writer :paging sig do params( - documents: T::Array[T.any(FinchAPI::Models::HRIS::DocumentResponse, FinchAPI::Internal::AnyHash)], - paging: T.any(FinchAPI::Models::Paging, FinchAPI::Internal::AnyHash) - ) - .returns(T.attached_class) + documents: T::Array[FinchAPI::HRIS::DocumentResponse::OrHash], + paging: FinchAPI::Paging::OrHash + ).returns(T.attached_class) + end + def self.new(documents:, paging:) end - def self.new(documents:, paging:); end sig do - override - .returns({documents: T::Array[FinchAPI::Models::HRIS::DocumentResponse], paging: FinchAPI::Models::Paging}) + override.returns( + { + documents: T::Array[FinchAPI::HRIS::DocumentResponse], + paging: FinchAPI::Paging + } + ) + end + def to_hash end - def to_hash; end end end end diff --git a/rbi/finch_api/models/hris/document_response.rbi b/rbi/finch_api/models/hris/document_response.rbi index 633ebb89..5f423f07 100644 --- a/rbi/finch_api/models/hris/document_response.rbi +++ b/rbi/finch_api/models/hris/document_response.rbi @@ -4,6 +4,9 @@ module FinchAPI module Models module HRIS class DocumentResponse < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + # A stable Finch id for the document. sig { returns(T.nilable(String)) } attr_reader :id @@ -17,10 +20,16 @@ module FinchAPI attr_accessor :individual_id # The type of document. - sig { returns(T.nilable(FinchAPI::Models::HRIS::DocumentResponse::Type::TaggedSymbol)) } + sig do + returns( + T.nilable(FinchAPI::HRIS::DocumentResponse::Type::TaggedSymbol) + ) + end attr_reader :type - sig { params(type: FinchAPI::Models::HRIS::DocumentResponse::Type::OrSymbol).void } + sig do + params(type: FinchAPI::HRIS::DocumentResponse::Type::OrSymbol).void + end attr_writer :type # A URL to access the document. Format: @@ -39,11 +48,10 @@ module FinchAPI params( id: String, individual_id: T.nilable(String), - type: FinchAPI::Models::HRIS::DocumentResponse::Type::OrSymbol, + type: FinchAPI::HRIS::DocumentResponse::Type::OrSymbol, url: String, year: T.nilable(Float) - ) - .returns(T.attached_class) + ).returns(T.attached_class) end def self.new( # A stable Finch id for the document. @@ -58,33 +66,51 @@ module FinchAPI url: nil, # The year the document applies to, if available. year: nil - ); end + ) + end + sig do - override - .returns( - { - id: String, - individual_id: T.nilable(String), - type: FinchAPI::Models::HRIS::DocumentResponse::Type::TaggedSymbol, - url: String, - year: T.nilable(Float) - } - ) + override.returns( + { + id: String, + individual_id: T.nilable(String), + type: FinchAPI::HRIS::DocumentResponse::Type::TaggedSymbol, + url: String, + year: T.nilable(Float) + } + ) + end + def to_hash end - def to_hash; end # The type of document. module Type extend FinchAPI::Internal::Type::Enum - TaggedSymbol = T.type_alias { T.all(Symbol, FinchAPI::Models::HRIS::DocumentResponse::Type) } + TaggedSymbol = + T.type_alias do + T.all(Symbol, FinchAPI::HRIS::DocumentResponse::Type) + end OrSymbol = T.type_alias { T.any(Symbol, String) } - W4_2020 = T.let(:w4_2020, FinchAPI::Models::HRIS::DocumentResponse::Type::TaggedSymbol) - W4_2005 = T.let(:w4_2005, FinchAPI::Models::HRIS::DocumentResponse::Type::TaggedSymbol) + W4_2020 = + T.let( + :w4_2020, + FinchAPI::HRIS::DocumentResponse::Type::TaggedSymbol + ) + W4_2005 = + T.let( + :w4_2005, + FinchAPI::HRIS::DocumentResponse::Type::TaggedSymbol + ) - sig { override.returns(T::Array[FinchAPI::Models::HRIS::DocumentResponse::Type::TaggedSymbol]) } - def self.values; end + sig do + override.returns( + T::Array[FinchAPI::HRIS::DocumentResponse::Type::TaggedSymbol] + ) + end + def self.values + end end end end diff --git a/rbi/finch_api/models/hris/document_retreive_params.rbi b/rbi/finch_api/models/hris/document_retreive_params.rbi index f4977821..076a555a 100644 --- a/rbi/finch_api/models/hris/document_retreive_params.rbi +++ b/rbi/finch_api/models/hris/document_retreive_params.rbi @@ -7,14 +7,20 @@ module FinchAPI extend FinchAPI::Internal::Type::RequestParameters::Converter include FinchAPI::Internal::Type::RequestParameters + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + sig do - params(request_options: T.any(FinchAPI::RequestOptions, FinchAPI::Internal::AnyHash)) - .returns(T.attached_class) + params(request_options: FinchAPI::RequestOptions::OrHash).returns( + T.attached_class + ) + end + def self.new(request_options: {}) end - def self.new(request_options: {}); end - sig { override.returns({request_options: FinchAPI::RequestOptions}) } - def to_hash; end + sig { override.returns({ request_options: FinchAPI::RequestOptions }) } + def to_hash + end end end end diff --git a/rbi/finch_api/models/hris/document_retreive_response.rbi b/rbi/finch_api/models/hris/document_retreive_response.rbi index 8fe4e05a..c80803ec 100644 --- a/rbi/finch_api/models/hris/document_retreive_response.rbi +++ b/rbi/finch_api/models/hris/document_retreive_response.rbi @@ -8,8 +8,16 @@ module FinchAPI module DocumentRetreiveResponse extend FinchAPI::Internal::Type::Union - sig { override.returns([FinchAPI::Models::HRIS::W42020, FinchAPI::Models::HRIS::W42005]) } - def self.variants; end + Variants = + T.type_alias { T.any(FinchAPI::HRIS::W42020, FinchAPI::HRIS::W42005) } + + sig do + override.returns( + T::Array[FinchAPI::Models::HRIS::DocumentRetreiveResponse::Variants] + ) + end + def self.variants + end end end end diff --git a/rbi/finch_api/models/hris/employment_data.rbi b/rbi/finch_api/models/hris/employment_data.rbi index ef5bad4e..1a541553 100644 --- a/rbi/finch_api/models/hris/employment_data.rbi +++ b/rbi/finch_api/models/hris/employment_data.rbi @@ -3,361 +3,699 @@ module FinchAPI module Models module HRIS - class EmploymentData < FinchAPI::Internal::Type::BaseModel - # A stable Finch `id` (UUID v4) for an individual in the company. - sig { returns(T.nilable(String)) } - attr_reader :id - - sig { params(id: String).void } - attr_writer :id - - # Worker's compensation classification code for this employee - sig { returns(T.nilable(String)) } - attr_accessor :class_code + module EmploymentData + extend FinchAPI::Internal::Type::Union + + Variants = + T.type_alias do + T.any( + FinchAPI::HRIS::EmploymentData::UnionMember0, + FinchAPI::HRIS::EmploymentData::BatchError + ) + 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])) } - attr_accessor :custom_fields + class UnionMember0 < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } - # The department object. - sig { returns(T.nilable(FinchAPI::Models::HRIS::EmploymentData::Department)) } - attr_reader :department + # A stable Finch `id` (UUID v4) for an individual in the company. + sig { returns(String) } + attr_accessor :id - sig do - params( - department: T.nilable(T.any(FinchAPI::Models::HRIS::EmploymentData::Department, FinchAPI::Internal::AnyHash)) - ) - .void - end - attr_writer :department + # Worker's compensation classification code for this employee + sig { returns(T.nilable(String)) } + attr_accessor :class_code - # The employment object. - sig { returns(T.nilable(FinchAPI::Models::HRIS::EmploymentData::Employment)) } - attr_reader :employment + # Custom fields for the individual. These are fields which are defined by the + # employer in the system. + sig do + returns( + T.nilable( + T::Array[ + FinchAPI::HRIS::EmploymentData::UnionMember0::CustomField + ] + ) + ) + end + attr_accessor :custom_fields - sig do - params( - employment: T.nilable(T.any(FinchAPI::Models::HRIS::EmploymentData::Employment, FinchAPI::Internal::AnyHash)) - ) - .void - end - attr_writer :employment + # The department object. + sig do + returns( + T.nilable( + FinchAPI::HRIS::EmploymentData::UnionMember0::Department + ) + ) + end + attr_reader :department - # 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)) } - attr_accessor :employment_status + sig do + params( + department: + T.nilable( + FinchAPI::HRIS::EmploymentData::UnionMember0::Department::OrHash + ) + ).void + end + attr_writer :department - sig { returns(T.nilable(String)) } - attr_accessor :end_date + # The employment object. + sig do + returns( + T.nilable( + FinchAPI::HRIS::EmploymentData::UnionMember0::Employment + ) + ) + end + attr_reader :employment - # The legal first name of the individual. - sig { returns(T.nilable(String)) } - attr_accessor :first_name + sig do + params( + employment: + T.nilable( + FinchAPI::HRIS::EmploymentData::UnionMember0::Employment::OrHash + ) + ).void + end + attr_writer :employment - # 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)) } - attr_reader :income + # The detailed employment status of the individual. Available options: `active`, + # `deceased`, `leave`, `onboarding`, `prehire`, `retired`, `terminated`. + sig do + returns( + T.nilable( + FinchAPI::HRIS::EmploymentData::UnionMember0::EmploymentStatus::TaggedSymbol + ) + ) + end + attr_accessor :employment_status - sig { params(income: T.nilable(T.any(FinchAPI::Models::Income, FinchAPI::Internal::AnyHash))).void } - attr_writer :income + sig { returns(T.nilable(String)) } + attr_accessor :end_date - # The array of income history. - sig { returns(T.nilable(T::Array[T.nilable(FinchAPI::Models::Income)])) } - attr_accessor :income_history + # The legal first name of the individual. + sig { returns(T.nilable(String)) } + attr_accessor :first_name - # `true` if the individual an an active employee or contractor at the company. - sig { returns(T.nilable(T::Boolean)) } - attr_accessor :is_active + # `true` if the individual an an active employee or contractor at the company. + sig { returns(T.nilable(T::Boolean)) } + attr_accessor :is_active - # The legal last name of the individual. - sig { returns(T.nilable(String)) } - attr_accessor :last_name + # The legal last name of the individual. + sig { returns(T.nilable(String)) } + attr_accessor :last_name - sig { returns(T.nilable(String)) } - attr_accessor :latest_rehire_date + sig { returns(T.nilable(String)) } + attr_accessor :latest_rehire_date - sig { returns(T.nilable(FinchAPI::Models::Location)) } - attr_reader :location + sig { returns(T.nilable(FinchAPI::Location)) } + attr_reader :location - sig { params(location: T.nilable(T.any(FinchAPI::Models::Location, FinchAPI::Internal::AnyHash))).void } - attr_writer :location + sig { params(location: T.nilable(FinchAPI::Location::OrHash)).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)) } - attr_reader :manager + # The manager object representing the manager of the individual within the org. + sig do + returns( + T.nilable(FinchAPI::HRIS::EmploymentData::UnionMember0::Manager) + ) + end + attr_reader :manager - sig do - params( - manager: T.nilable(T.any(FinchAPI::Models::HRIS::EmploymentData::Manager, FinchAPI::Internal::AnyHash)) - ) - .void - end - attr_writer :manager + sig do + params( + manager: + T.nilable( + FinchAPI::HRIS::EmploymentData::UnionMember0::Manager::OrHash + ) + ).void + end + attr_writer :manager - # The legal middle name of the individual. - sig { returns(T.nilable(String)) } - attr_accessor :middle_name + # The legal middle name of the individual. + sig { returns(T.nilable(String)) } + attr_accessor :middle_name - # The source system's unique employment identifier for this individual - sig { returns(T.nilable(String)) } - attr_accessor :source_id + # The source system's unique employment identifier for this individual + sig { returns(T.nilable(String)) } + attr_accessor :source_id - sig { returns(T.nilable(String)) } - attr_accessor :start_date + sig { returns(T.nilable(String)) } + attr_accessor :start_date - # The current title of the individual. - sig { returns(T.nilable(String)) } - attr_accessor :title + # The current title of the individual. + sig { returns(T.nilable(String)) } + attr_accessor :title - # This field is deprecated in favour of `source_id` - sig { returns(T.nilable(String)) } - attr_accessor :work_id + # This field is deprecated in favour of `source_id` + sig { returns(T.nilable(String)) } + attr_accessor :work_id - sig do - params( - id: String, - class_code: T.nilable(String), - custom_fields: T.nilable( - T::Array[T.any(FinchAPI::Models::HRIS::EmploymentData::CustomField, FinchAPI::Internal::AnyHash)] - ), - department: T.nilable(T.any(FinchAPI::Models::HRIS::EmploymentData::Department, FinchAPI::Internal::AnyHash)), - employment: T.nilable(T.any(FinchAPI::Models::HRIS::EmploymentData::Employment, FinchAPI::Internal::AnyHash)), - 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::Internal::AnyHash)), - income_history: T.nilable(T::Array[T.nilable(T.any(FinchAPI::Models::Income, FinchAPI::Internal::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::Internal::AnyHash)), - manager: T.nilable(T.any(FinchAPI::Models::HRIS::EmploymentData::Manager, FinchAPI::Internal::AnyHash)), - middle_name: T.nilable(String), - source_id: T.nilable(String), - start_date: T.nilable(String), - title: T.nilable(String), - work_id: T.nilable(String) - ) - .returns(T.attached_class) - end - def self.new( - # A stable Finch `id` (UUID v4) for an individual in the company. - id: nil, - # 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: nil, - # The department object. - department: nil, - # The employment object. - employment: nil, - # The detailed employment status of the individual. Available options: `active`, - # `deceased`, `leave`, `onboarding`, `prehire`, `retired`, `terminated`. - 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, + sig { returns(T.nilable(FinchAPI::Income)) } + attr_reader :income + + sig { params(income: T.nilable(FinchAPI::Income::OrHash)).void } + attr_writer :income + # 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, - # This field is deprecated in favour of `source_id` - work_id: nil - ); end - sig do - override - .returns( + sig { returns(T.nilable(T::Array[T.nilable(FinchAPI::Income)])) } + attr_accessor :income_history + + sig do + params( + id: String, + class_code: T.nilable(String), + custom_fields: + T.nilable( + T::Array[ + FinchAPI::HRIS::EmploymentData::UnionMember0::CustomField::OrHash + ] + ), + department: + T.nilable( + FinchAPI::HRIS::EmploymentData::UnionMember0::Department::OrHash + ), + employment: + T.nilable( + FinchAPI::HRIS::EmploymentData::UnionMember0::Employment::OrHash + ), + employment_status: + T.nilable( + FinchAPI::HRIS::EmploymentData::UnionMember0::EmploymentStatus::OrSymbol + ), + end_date: T.nilable(String), + first_name: T.nilable(String), + is_active: T.nilable(T::Boolean), + last_name: T.nilable(String), + latest_rehire_date: T.nilable(String), + location: T.nilable(FinchAPI::Location::OrHash), + manager: + T.nilable( + FinchAPI::HRIS::EmploymentData::UnionMember0::Manager::OrHash + ), + middle_name: T.nilable(String), + source_id: T.nilable(String), + start_date: T.nilable(String), + title: T.nilable(String), + work_id: T.nilable(String), + income: T.nilable(FinchAPI::Income::OrHash), + income_history: + T.nilable(T::Array[T.nilable(FinchAPI::Income::OrHash)]) + ).returns(T.attached_class) + end + def self.new( + # A stable Finch `id` (UUID v4) for an individual in the company. + id:, + # Worker's compensation classification code for this employee + class_code:, + # Custom fields for the individual. These are fields which are defined by the + # employer in the system. + custom_fields:, + # The department object. + department:, + # The employment object. + employment:, + # The detailed employment status of the individual. Available options: `active`, + # `deceased`, `leave`, `onboarding`, `prehire`, `retired`, `terminated`. + employment_status:, + end_date:, + # The legal first name of the individual. + first_name:, + # `true` if the individual an an active employee or contractor at the company. + is_active:, + # The legal last name of the individual. + last_name:, + latest_rehire_date:, + location:, + # The manager object representing the manager of the individual within the org. + manager:, + # The legal middle name of the individual. + middle_name:, + # The source system's unique employment identifier for this individual + source_id:, + start_date:, + # The current title of the individual. + title:, + # This field is deprecated in favour of `source_id` + work_id:, + # 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 + ) + end + + sig do + override.returns( { 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), - employment_status: T.nilable(FinchAPI::Models::HRIS::EmploymentData::EmploymentStatus::TaggedSymbol), + custom_fields: + T.nilable( + T::Array[ + FinchAPI::HRIS::EmploymentData::UnionMember0::CustomField + ] + ), + department: + T.nilable( + FinchAPI::HRIS::EmploymentData::UnionMember0::Department + ), + employment: + T.nilable( + FinchAPI::HRIS::EmploymentData::UnionMember0::Employment + ), + employment_status: + T.nilable( + FinchAPI::HRIS::EmploymentData::UnionMember0::EmploymentStatus::TaggedSymbol + ), 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)]), 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(FinchAPI::Location), + manager: + T.nilable( + FinchAPI::HRIS::EmploymentData::UnionMember0::Manager + ), middle_name: T.nilable(String), source_id: T.nilable(String), start_date: T.nilable(String), title: T.nilable(String), - work_id: T.nilable(String) + work_id: T.nilable(String), + income: T.nilable(FinchAPI::Income), + income_history: T.nilable(T::Array[T.nilable(FinchAPI::Income)]) } ) - end - def to_hash; end - - class CustomField < FinchAPI::Internal::Type::BaseModel - sig { returns(T.nilable(String)) } - attr_reader :name - - sig { params(name: String).void } - attr_writer :name - - sig { returns(T.nilable(T.anything)) } - attr_reader :value - - 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); end + end + def to_hash + end - sig { override.returns({name: String, value: T.anything}) } - def to_hash; end - end + class CustomField < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + + sig { returns(T.nilable(String)) } + attr_reader :name + + sig { params(name: String).void } + attr_writer :name + + sig do + returns( + T.nilable( + T.any( + String, + T::Array[T.anything], + T.anything, + Float, + T::Boolean + ) + ) + ) + end + attr_accessor :value + + sig do + params( + name: String, + value: + T.nilable( + T.any( + String, + T::Array[T.anything], + T.anything, + Float, + T::Boolean + ) + ) + ).returns(T.attached_class) + end + def self.new(name: nil, value: nil) + end + + sig do + override.returns( + { + name: String, + value: + T.nilable( + T.any( + String, + T::Array[T.anything], + T.anything, + Float, + T::Boolean + ) + ) + } + ) + end + def to_hash + end + + module Value + extend FinchAPI::Internal::Type::Union + + Variants = + T.type_alias do + T.any( + String, + T::Array[T.anything], + T.anything, + Float, + T::Boolean + ) + end + + sig do + override.returns( + T::Array[ + FinchAPI::HRIS::EmploymentData::UnionMember0::CustomField::Value::Variants + ] + ) + end + def self.variants + end + + UnionMember1Array = + T.let( + FinchAPI::Internal::Type::ArrayOf[ + FinchAPI::Internal::Type::Unknown + ], + FinchAPI::Internal::Type::Converter + ) + end + end - class Department < FinchAPI::Internal::Type::BaseModel - # The name of the department associated with the individual. - sig { returns(T.nilable(String)) } - attr_accessor :name + class Department < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } - # The department object. - sig { params(name: T.nilable(String)).returns(T.attached_class) } - def self.new( # The name of the department associated with the individual. - name: nil - ); end - sig { override.returns({name: T.nilable(String)}) } - def to_hash; end - end + sig { returns(T.nilable(String)) } + attr_accessor :name + + # The department object. + sig { params(name: T.nilable(String)).returns(T.attached_class) } + def self.new( + # The name of the department associated with the individual. + name: + ) + end - class Employment < FinchAPI::Internal::Type::BaseModel - # 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)) } - attr_accessor :subtype + sig { override.returns({ name: T.nilable(String) }) } + def to_hash + end + end - # The main employment type of the individual. - sig { returns(T.nilable(FinchAPI::Models::HRIS::EmploymentData::Employment::Type::TaggedSymbol)) } - attr_accessor :type + class Employment < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } - # The employment object. - sig do - params( - 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 - def self.new( # The secondary employment type of the individual. Options: `full_time`, # `part_time`, `intern`, `temp`, `seasonal` and `individual_contractor`. - subtype: nil, + sig do + returns( + T.nilable( + FinchAPI::HRIS::EmploymentData::UnionMember0::Employment::Subtype::TaggedSymbol + ) + ) + end + attr_accessor :subtype + # The main employment type of the individual. - type: nil - ); end - sig do - override - .returns( + sig do + returns( + T.nilable( + FinchAPI::HRIS::EmploymentData::UnionMember0::Employment::Type::TaggedSymbol + ) + ) + end + attr_accessor :type + + # The employment object. + sig do + params( + subtype: + T.nilable( + FinchAPI::HRIS::EmploymentData::UnionMember0::Employment::Subtype::OrSymbol + ), + type: + T.nilable( + FinchAPI::HRIS::EmploymentData::UnionMember0::Employment::Type::OrSymbol + ) + ).returns(T.attached_class) + end + def self.new( + # The secondary employment type of the individual. Options: `full_time`, + # `part_time`, `intern`, `temp`, `seasonal` and `individual_contractor`. + subtype:, + # The main employment type of the individual. + type: + ) + end + + sig do + override.returns( { - subtype: T.nilable(FinchAPI::Models::HRIS::EmploymentData::Employment::Subtype::TaggedSymbol), - type: T.nilable(FinchAPI::Models::HRIS::EmploymentData::Employment::Type::TaggedSymbol) + subtype: + T.nilable( + FinchAPI::HRIS::EmploymentData::UnionMember0::Employment::Subtype::TaggedSymbol + ), + type: + T.nilable( + FinchAPI::HRIS::EmploymentData::UnionMember0::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`. + module Subtype + extend FinchAPI::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + FinchAPI::HRIS::EmploymentData::UnionMember0::Employment::Subtype + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + FULL_TIME = + T.let( + :full_time, + FinchAPI::HRIS::EmploymentData::UnionMember0::Employment::Subtype::TaggedSymbol + ) + INTERN = + T.let( + :intern, + FinchAPI::HRIS::EmploymentData::UnionMember0::Employment::Subtype::TaggedSymbol + ) + PART_TIME = + T.let( + :part_time, + FinchAPI::HRIS::EmploymentData::UnionMember0::Employment::Subtype::TaggedSymbol + ) + TEMP = + T.let( + :temp, + FinchAPI::HRIS::EmploymentData::UnionMember0::Employment::Subtype::TaggedSymbol + ) + SEASONAL = + T.let( + :seasonal, + FinchAPI::HRIS::EmploymentData::UnionMember0::Employment::Subtype::TaggedSymbol + ) + INDIVIDUAL_CONTRACTOR = + T.let( + :individual_contractor, + FinchAPI::HRIS::EmploymentData::UnionMember0::Employment::Subtype::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + FinchAPI::HRIS::EmploymentData::UnionMember0::Employment::Subtype::TaggedSymbol + ] + ) + end + def self.values + end + end + + # The main employment type of the individual. + module Type + extend FinchAPI::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + FinchAPI::HRIS::EmploymentData::UnionMember0::Employment::Type + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + EMPLOYEE = + T.let( + :employee, + FinchAPI::HRIS::EmploymentData::UnionMember0::Employment::Type::TaggedSymbol + ) + CONTRACTOR = + T.let( + :contractor, + FinchAPI::HRIS::EmploymentData::UnionMember0::Employment::Type::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + FinchAPI::HRIS::EmploymentData::UnionMember0::Employment::Type::TaggedSymbol + ] + ) + end + def self.values + end + end end - def to_hash; end - # The secondary employment type of the individual. Options: `full_time`, - # `part_time`, `intern`, `temp`, `seasonal` and `individual_contractor`. - module Subtype + # The detailed employment status of the individual. Available options: `active`, + # `deceased`, `leave`, `onboarding`, `prehire`, `retired`, `terminated`. + module EmploymentStatus extend FinchAPI::Internal::Type::Enum TaggedSymbol = - T.type_alias { T.all(Symbol, FinchAPI::Models::HRIS::EmploymentData::Employment::Subtype) } + T.type_alias do + T.all( + Symbol, + FinchAPI::HRIS::EmploymentData::UnionMember0::EmploymentStatus + ) + end OrSymbol = T.type_alias { T.any(Symbol, String) } - 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) + ACTIVE = + T.let( + :active, + FinchAPI::HRIS::EmploymentData::UnionMember0::EmploymentStatus::TaggedSymbol + ) + DECEASED = + T.let( + :deceased, + FinchAPI::HRIS::EmploymentData::UnionMember0::EmploymentStatus::TaggedSymbol + ) + LEAVE = + T.let( + :leave, + FinchAPI::HRIS::EmploymentData::UnionMember0::EmploymentStatus::TaggedSymbol + ) + ONBOARDING = + T.let( + :onboarding, + FinchAPI::HRIS::EmploymentData::UnionMember0::EmploymentStatus::TaggedSymbol + ) + PREHIRE = + T.let( + :prehire, + FinchAPI::HRIS::EmploymentData::UnionMember0::EmploymentStatus::TaggedSymbol + ) + RETIRED = + T.let( + :retired, + FinchAPI::HRIS::EmploymentData::UnionMember0::EmploymentStatus::TaggedSymbol + ) + TERMINATED = + T.let( + :terminated, + FinchAPI::HRIS::EmploymentData::UnionMember0::EmploymentStatus::TaggedSymbol + ) - sig { override.returns(T::Array[FinchAPI::Models::HRIS::EmploymentData::Employment::Subtype::TaggedSymbol]) } - def self.values; end + sig do + override.returns( + T::Array[ + FinchAPI::HRIS::EmploymentData::UnionMember0::EmploymentStatus::TaggedSymbol + ] + ) + end + def self.values + end end - # The main employment type of the individual. - module Type - extend FinchAPI::Internal::Type::Enum - - TaggedSymbol = T.type_alias { T.all(Symbol, FinchAPI::Models::HRIS::EmploymentData::Employment::Type) } - OrSymbol = T.type_alias { T.any(Symbol, String) } + class Manager < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } - EMPLOYEE = T.let(:employee, FinchAPI::Models::HRIS::EmploymentData::Employment::Type::TaggedSymbol) - CONTRACTOR = T.let(:contractor, FinchAPI::Models::HRIS::EmploymentData::Employment::Type::TaggedSymbol) + # A stable Finch `id` (UUID v4) for an individual in the company. + sig { returns(String) } + attr_accessor :id + + # The manager object representing the manager of the individual within the org. + sig { params(id: String).returns(T.attached_class) } + def self.new( + # A stable Finch `id` (UUID v4) for an individual in the company. + id: + ) + end - sig { override.returns(T::Array[FinchAPI::Models::HRIS::EmploymentData::Employment::Type::TaggedSymbol]) } - def self.values; end + sig { override.returns({ id: String }) } + def to_hash + end end end - # The detailed employment status of the individual. Available options: `active`, - # `deceased`, `leave`, `onboarding`, `prehire`, `retired`, `terminated`. - module EmploymentStatus - extend FinchAPI::Internal::Type::Enum + class BatchError < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } - TaggedSymbol = T.type_alias { T.all(Symbol, FinchAPI::Models::HRIS::EmploymentData::EmploymentStatus) } - OrSymbol = T.type_alias { T.any(Symbol, String) } + sig { returns(Float) } + attr_accessor :code - 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) + sig { returns(String) } + attr_accessor :message - sig { override.returns(T::Array[FinchAPI::Models::HRIS::EmploymentData::EmploymentStatus::TaggedSymbol]) } - def self.values; end - end + sig { returns(String) } + attr_accessor :name - class Manager < FinchAPI::Internal::Type::BaseModel - # A stable Finch `id` (UUID v4) for an individual in the company. sig { returns(T.nilable(String)) } - attr_reader :id + attr_reader :finch_code - sig { params(id: String).void } - attr_writer :id + sig { params(finch_code: String).void } + attr_writer :finch_code - # The manager object representing the manager of the individual within the org. - sig { params(id: String).returns(T.attached_class) } - def self.new( - # A stable Finch `id` (UUID v4) for an individual in the company. - id: nil - ); end - sig { override.returns({id: String}) } - def to_hash; end + sig do + params( + code: Float, + message: String, + name: String, + finch_code: String + ).returns(T.attached_class) + end + def self.new(code:, message:, name:, finch_code: nil) + end + + sig do + override.returns( + { code: Float, message: String, name: String, finch_code: String } + ) + end + def to_hash + end + end + + sig do + override.returns(T::Array[FinchAPI::HRIS::EmploymentData::Variants]) + end + def self.variants end end end diff --git a/rbi/finch_api/models/hris/employment_data_response.rbi b/rbi/finch_api/models/hris/employment_data_response.rbi index 91564a01..adb2704f 100644 --- a/rbi/finch_api/models/hris/employment_data_response.rbi +++ b/rbi/finch_api/models/hris/employment_data_response.rbi @@ -4,41 +4,60 @@ module FinchAPI module Models module HRIS class EmploymentDataResponse < FinchAPI::Internal::Type::BaseModel - sig { returns(T.nilable(FinchAPI::Models::HRIS::EmploymentData)) } - attr_reader :body + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } - sig { params(body: T.any(FinchAPI::Models::HRIS::EmploymentData, FinchAPI::Internal::AnyHash)).void } - attr_writer :body - - sig { returns(T.nilable(Integer)) } - attr_reader :code + sig do + returns( + T.any( + FinchAPI::HRIS::EmploymentData::UnionMember0, + FinchAPI::HRIS::EmploymentData::BatchError + ) + ) + end + attr_accessor :body - sig { params(code: Integer).void } - attr_writer :code + sig { returns(Integer) } + attr_accessor :code # A stable Finch `id` (UUID v4) for an individual in the company. - sig { returns(T.nilable(String)) } - attr_reader :individual_id - - sig { params(individual_id: String).void } - attr_writer :individual_id + sig { returns(String) } + attr_accessor :individual_id sig do params( - body: T.any(FinchAPI::Models::HRIS::EmploymentData, FinchAPI::Internal::AnyHash), + body: + T.any( + FinchAPI::HRIS::EmploymentData::UnionMember0::OrHash, + FinchAPI::HRIS::EmploymentData::BatchError::OrHash + ), code: Integer, individual_id: String - ) - .returns(T.attached_class) + ).returns(T.attached_class) end def self.new( - body: nil, - code: nil, + body:, + code:, # A stable Finch `id` (UUID v4) for an individual in the company. - individual_id: nil - ); end - sig { override.returns({body: FinchAPI::Models::HRIS::EmploymentData, code: Integer, individual_id: String}) } - def to_hash; end + individual_id: + ) + end + + sig do + override.returns( + { + body: + T.any( + FinchAPI::HRIS::EmploymentData::UnionMember0, + FinchAPI::HRIS::EmploymentData::BatchError + ), + code: Integer, + individual_id: String + } + ) + end + def to_hash + end end end end diff --git a/rbi/finch_api/models/hris/employment_retrieve_many_params.rbi b/rbi/finch_api/models/hris/employment_retrieve_many_params.rbi index 6a59e73a..3fe6eb78 100644 --- a/rbi/finch_api/models/hris/employment_retrieve_many_params.rbi +++ b/rbi/finch_api/models/hris/employment_retrieve_many_params.rbi @@ -7,34 +7,49 @@ module FinchAPI extend FinchAPI::Internal::Type::RequestParameters::Converter include FinchAPI::Internal::Type::RequestParameters + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + # The array of batch requests. - sig { returns(T::Array[FinchAPI::Models::HRIS::EmploymentRetrieveManyParams::Request]) } + sig do + returns( + T::Array[FinchAPI::HRIS::EmploymentRetrieveManyParams::Request] + ) + end attr_accessor :requests sig do params( - requests: T::Array[T.any(FinchAPI::Models::HRIS::EmploymentRetrieveManyParams::Request, FinchAPI::Internal::AnyHash)], - request_options: T.any(FinchAPI::RequestOptions, FinchAPI::Internal::AnyHash) - ) - .returns(T.attached_class) + requests: + T::Array[ + FinchAPI::HRIS::EmploymentRetrieveManyParams::Request::OrHash + ], + request_options: FinchAPI::RequestOptions::OrHash + ).returns(T.attached_class) end def self.new( # The array of batch requests. requests:, request_options: {} - ); end + ) + end + sig do - override - .returns( - { - requests: T::Array[FinchAPI::Models::HRIS::EmploymentRetrieveManyParams::Request], - request_options: FinchAPI::RequestOptions - } - ) + override.returns( + { + requests: + T::Array[FinchAPI::HRIS::EmploymentRetrieveManyParams::Request], + request_options: FinchAPI::RequestOptions + } + ) + end + def to_hash end - def to_hash; end class Request < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + # 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. @@ -47,9 +62,12 @@ 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. individual_id: - ); end - sig { override.returns({individual_id: String}) } - def to_hash; end + ) + end + + sig { override.returns({ individual_id: String }) } + def to_hash + end end end end diff --git a/rbi/finch_api/models/hris/individual.rbi b/rbi/finch_api/models/hris/individual.rbi index 2b52ef67..06733d8d 100644 --- a/rbi/finch_api/models/hris/individual.rbi +++ b/rbi/finch_api/models/hris/individual.rbi @@ -6,7 +6,18 @@ module FinchAPI module Individual extend FinchAPI::Internal::Type::Union + Variants = + T.type_alias do + T.any( + FinchAPI::HRIS::Individual::UnionMember0, + FinchAPI::HRIS::Individual::BatchError + ) + end + class UnionMember0 < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + # A stable Finch `id` (UUID v4) for an individual in the company. sig { returns(String) } attr_accessor :id @@ -15,7 +26,13 @@ module FinchAPI attr_accessor :dob # The EEOC-defined ethnicity of the individual. - sig { returns(T.nilable(FinchAPI::Models::HRIS::Individual::UnionMember0::Ethnicity::TaggedSymbol)) } + sig do + returns( + T.nilable( + FinchAPI::HRIS::Individual::UnionMember0::Ethnicity::TaggedSymbol + ) + ) + end attr_accessor :ethnicity # The legal first name of the individual. @@ -23,7 +40,13 @@ module FinchAPI attr_accessor :first_name # The gender of the individual. - sig { returns(T.nilable(FinchAPI::Models::HRIS::Individual::UnionMember0::Gender::TaggedSymbol)) } + sig do + returns( + T.nilable( + FinchAPI::HRIS::Individual::UnionMember0::Gender::TaggedSymbol + ) + ) + end attr_accessor :gender # The legal last name of the individual. @@ -34,20 +57,36 @@ module FinchAPI sig { returns(T.nilable(String)) } attr_accessor :middle_name - sig { returns(T.nilable(T::Array[T.nilable(FinchAPI::Models::HRIS::Individual::UnionMember0::PhoneNumber)])) } + sig do + returns( + T.nilable( + T::Array[ + T.nilable( + FinchAPI::HRIS::Individual::UnionMember0::PhoneNumber + ) + ] + ) + ) + end attr_accessor :phone_numbers # The preferred name of the individual. sig { returns(T.nilable(String)) } attr_accessor :preferred_name - sig { returns(T.nilable(FinchAPI::Models::Location)) } + sig { returns(T.nilable(FinchAPI::Location)) } attr_reader :residence - sig { params(residence: T.nilable(T.any(FinchAPI::Models::Location, FinchAPI::Internal::AnyHash))).void } + sig { params(residence: T.nilable(FinchAPI::Location::OrHash)).void } attr_writer :residence - sig { returns(T.nilable(T::Array[FinchAPI::Models::HRIS::Individual::UnionMember0::Email])) } + sig do + returns( + T.nilable( + T::Array[FinchAPI::HRIS::Individual::UnionMember0::Email] + ) + ) + end attr_accessor :emails # Social Security Number of the individual in **encrypted** format. This field is @@ -67,27 +106,36 @@ module FinchAPI params( id: String, dob: T.nilable(String), - ethnicity: T.nilable(FinchAPI::Models::HRIS::Individual::UnionMember0::Ethnicity::OrSymbol), + ethnicity: + T.nilable( + FinchAPI::HRIS::Individual::UnionMember0::Ethnicity::OrSymbol + ), first_name: T.nilable(String), - gender: T.nilable(FinchAPI::Models::HRIS::Individual::UnionMember0::Gender::OrSymbol), + gender: + T.nilable( + FinchAPI::HRIS::Individual::UnionMember0::Gender::OrSymbol + ), last_name: T.nilable(String), middle_name: T.nilable(String), - phone_numbers: T.nilable( - T::Array[ - T.nilable( - T.any(FinchAPI::Models::HRIS::Individual::UnionMember0::PhoneNumber, FinchAPI::Internal::AnyHash) - ) - ] - ), + phone_numbers: + T.nilable( + T::Array[ + T.nilable( + FinchAPI::HRIS::Individual::UnionMember0::PhoneNumber::OrHash + ) + ] + ), preferred_name: T.nilable(String), - residence: T.nilable(T.any(FinchAPI::Models::Location, FinchAPI::Internal::AnyHash)), - emails: T.nilable( - T::Array[T.any(FinchAPI::Models::HRIS::Individual::UnionMember0::Email, FinchAPI::Internal::AnyHash)] - ), + residence: T.nilable(FinchAPI::Location::OrHash), + emails: + T.nilable( + T::Array[ + FinchAPI::HRIS::Individual::UnionMember0::Email::OrHash + ] + ), encrypted_ssn: T.nilable(String), ssn: T.nilable(String) - ) - .returns(T.attached_class) + ).returns(T.attached_class) end def self.new( # A stable Finch `id` (UUID v4) for an individual in the company. @@ -117,169 +165,313 @@ module FinchAPI # body. # [Click here to learn more about enabling the SSN field](/developer-resources/Enable-SSN-Field). ssn: nil - ); end + ) + end + sig do - override - .returns( - { - id: String, - dob: T.nilable(String), - ethnicity: T.nilable(FinchAPI::Models::HRIS::Individual::UnionMember0::Ethnicity::TaggedSymbol), - first_name: T.nilable(String), - gender: T.nilable(FinchAPI::Models::HRIS::Individual::UnionMember0::Gender::TaggedSymbol), - last_name: T.nilable(String), - middle_name: T.nilable(String), - phone_numbers: T.nilable(T::Array[T.nilable(FinchAPI::Models::HRIS::Individual::UnionMember0::PhoneNumber)]), - preferred_name: T.nilable(String), - residence: T.nilable(FinchAPI::Models::Location), - emails: T.nilable(T::Array[FinchAPI::Models::HRIS::Individual::UnionMember0::Email]), - encrypted_ssn: T.nilable(String), - ssn: T.nilable(String) - } - ) + override.returns( + { + id: String, + dob: T.nilable(String), + ethnicity: + T.nilable( + FinchAPI::HRIS::Individual::UnionMember0::Ethnicity::TaggedSymbol + ), + first_name: T.nilable(String), + gender: + T.nilable( + FinchAPI::HRIS::Individual::UnionMember0::Gender::TaggedSymbol + ), + last_name: T.nilable(String), + middle_name: T.nilable(String), + phone_numbers: + T.nilable( + T::Array[ + T.nilable( + FinchAPI::HRIS::Individual::UnionMember0::PhoneNumber + ) + ] + ), + preferred_name: T.nilable(String), + residence: T.nilable(FinchAPI::Location), + emails: + T.nilable( + T::Array[FinchAPI::HRIS::Individual::UnionMember0::Email] + ), + encrypted_ssn: T.nilable(String), + ssn: T.nilable(String) + } + ) + end + def to_hash end - def to_hash; end # The EEOC-defined ethnicity of the individual. module Ethnicity extend FinchAPI::Internal::Type::Enum TaggedSymbol = - T.type_alias { T.all(Symbol, FinchAPI::Models::HRIS::Individual::UnionMember0::Ethnicity) } + T.type_alias do + T.all( + Symbol, + FinchAPI::HRIS::Individual::UnionMember0::Ethnicity + ) + end OrSymbol = T.type_alias { T.any(Symbol, String) } - ASIAN = T.let(:asian, FinchAPI::Models::HRIS::Individual::UnionMember0::Ethnicity::TaggedSymbol) - WHITE = T.let(:white, FinchAPI::Models::HRIS::Individual::UnionMember0::Ethnicity::TaggedSymbol) + ASIAN = + T.let( + :asian, + FinchAPI::HRIS::Individual::UnionMember0::Ethnicity::TaggedSymbol + ) + WHITE = + T.let( + :white, + FinchAPI::HRIS::Individual::UnionMember0::Ethnicity::TaggedSymbol + ) BLACK_OR_AFRICAN_AMERICAN = T.let( :black_or_african_american, - FinchAPI::Models::HRIS::Individual::UnionMember0::Ethnicity::TaggedSymbol + FinchAPI::HRIS::Individual::UnionMember0::Ethnicity::TaggedSymbol ) NATIVE_HAWAIIAN_OR_PACIFIC_ISLANDER = T.let( :native_hawaiian_or_pacific_islander, - FinchAPI::Models::HRIS::Individual::UnionMember0::Ethnicity::TaggedSymbol + FinchAPI::HRIS::Individual::UnionMember0::Ethnicity::TaggedSymbol ) AMERICAN_INDIAN_OR_ALASKA_NATIVE = T.let( :american_indian_or_alaska_native, - FinchAPI::Models::HRIS::Individual::UnionMember0::Ethnicity::TaggedSymbol + FinchAPI::HRIS::Individual::UnionMember0::Ethnicity::TaggedSymbol ) HISPANIC_OR_LATINO = - T.let(:hispanic_or_latino, FinchAPI::Models::HRIS::Individual::UnionMember0::Ethnicity::TaggedSymbol) + T.let( + :hispanic_or_latino, + FinchAPI::HRIS::Individual::UnionMember0::Ethnicity::TaggedSymbol + ) TWO_OR_MORE_RACES = - T.let(:two_or_more_races, FinchAPI::Models::HRIS::Individual::UnionMember0::Ethnicity::TaggedSymbol) + T.let( + :two_or_more_races, + FinchAPI::HRIS::Individual::UnionMember0::Ethnicity::TaggedSymbol + ) DECLINE_TO_SPECIFY = - T.let(:decline_to_specify, FinchAPI::Models::HRIS::Individual::UnionMember0::Ethnicity::TaggedSymbol) + T.let( + :decline_to_specify, + FinchAPI::HRIS::Individual::UnionMember0::Ethnicity::TaggedSymbol + ) - sig { override.returns(T::Array[FinchAPI::Models::HRIS::Individual::UnionMember0::Ethnicity::TaggedSymbol]) } - def self.values; end + sig do + override.returns( + T::Array[ + FinchAPI::HRIS::Individual::UnionMember0::Ethnicity::TaggedSymbol + ] + ) + end + def self.values + end end # The gender of the individual. module Gender extend FinchAPI::Internal::Type::Enum - TaggedSymbol = T.type_alias { T.all(Symbol, FinchAPI::Models::HRIS::Individual::UnionMember0::Gender) } + TaggedSymbol = + T.type_alias do + T.all(Symbol, FinchAPI::HRIS::Individual::UnionMember0::Gender) + end OrSymbol = T.type_alias { T.any(Symbol, String) } - FEMALE = T.let(:female, FinchAPI::Models::HRIS::Individual::UnionMember0::Gender::TaggedSymbol) - MALE = T.let(:male, FinchAPI::Models::HRIS::Individual::UnionMember0::Gender::TaggedSymbol) - OTHER = T.let(:other, FinchAPI::Models::HRIS::Individual::UnionMember0::Gender::TaggedSymbol) + FEMALE = + T.let( + :female, + FinchAPI::HRIS::Individual::UnionMember0::Gender::TaggedSymbol + ) + MALE = + T.let( + :male, + FinchAPI::HRIS::Individual::UnionMember0::Gender::TaggedSymbol + ) + OTHER = + T.let( + :other, + FinchAPI::HRIS::Individual::UnionMember0::Gender::TaggedSymbol + ) DECLINE_TO_SPECIFY = - T.let(:decline_to_specify, FinchAPI::Models::HRIS::Individual::UnionMember0::Gender::TaggedSymbol) + T.let( + :decline_to_specify, + FinchAPI::HRIS::Individual::UnionMember0::Gender::TaggedSymbol + ) - sig { override.returns(T::Array[FinchAPI::Models::HRIS::Individual::UnionMember0::Gender::TaggedSymbol]) } - def self.values; end + sig do + override.returns( + T::Array[ + FinchAPI::HRIS::Individual::UnionMember0::Gender::TaggedSymbol + ] + ) + end + def self.values + end end class PhoneNumber < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + sig { returns(T.nilable(String)) } attr_accessor :data - sig { returns(T.nilable(FinchAPI::Models::HRIS::Individual::UnionMember0::PhoneNumber::Type::TaggedSymbol)) } + sig do + returns( + T.nilable( + FinchAPI::HRIS::Individual::UnionMember0::PhoneNumber::Type::TaggedSymbol + ) + ) + end attr_accessor :type sig do params( data: T.nilable(String), - type: T.nilable(FinchAPI::Models::HRIS::Individual::UnionMember0::PhoneNumber::Type::OrSymbol) - ) - .returns(T.attached_class) + type: + T.nilable( + FinchAPI::HRIS::Individual::UnionMember0::PhoneNumber::Type::OrSymbol + ) + ).returns(T.attached_class) + end + def self.new(data:, type:) end - def self.new(data:, type:); end sig do - override - .returns( - { - data: T.nilable(String), - type: T.nilable(FinchAPI::Models::HRIS::Individual::UnionMember0::PhoneNumber::Type::TaggedSymbol) - } - ) + override.returns( + { + data: T.nilable(String), + type: + T.nilable( + FinchAPI::HRIS::Individual::UnionMember0::PhoneNumber::Type::TaggedSymbol + ) + } + ) + end + def to_hash end - def to_hash; end module Type extend FinchAPI::Internal::Type::Enum TaggedSymbol = - T.type_alias { T.all(Symbol, FinchAPI::Models::HRIS::Individual::UnionMember0::PhoneNumber::Type) } + T.type_alias do + T.all( + Symbol, + FinchAPI::HRIS::Individual::UnionMember0::PhoneNumber::Type + ) + end OrSymbol = T.type_alias { T.any(Symbol, String) } - WORK = T.let(:work, FinchAPI::Models::HRIS::Individual::UnionMember0::PhoneNumber::Type::TaggedSymbol) + WORK = + T.let( + :work, + FinchAPI::HRIS::Individual::UnionMember0::PhoneNumber::Type::TaggedSymbol + ) PERSONAL = - T.let(:personal, FinchAPI::Models::HRIS::Individual::UnionMember0::PhoneNumber::Type::TaggedSymbol) + T.let( + :personal, + FinchAPI::HRIS::Individual::UnionMember0::PhoneNumber::Type::TaggedSymbol + ) sig do - override - .returns(T::Array[FinchAPI::Models::HRIS::Individual::UnionMember0::PhoneNumber::Type::TaggedSymbol]) + override.returns( + T::Array[ + FinchAPI::HRIS::Individual::UnionMember0::PhoneNumber::Type::TaggedSymbol + ] + ) + end + def self.values end - def self.values; end end end class Email < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + sig { returns(String) } attr_accessor :data - sig { returns(T.nilable(FinchAPI::Models::HRIS::Individual::UnionMember0::Email::Type::TaggedSymbol)) } + sig do + returns( + T.nilable( + FinchAPI::HRIS::Individual::UnionMember0::Email::Type::TaggedSymbol + ) + ) + end attr_accessor :type sig do params( data: String, - type: T.nilable(FinchAPI::Models::HRIS::Individual::UnionMember0::Email::Type::OrSymbol) - ) - .returns(T.attached_class) + type: + T.nilable( + FinchAPI::HRIS::Individual::UnionMember0::Email::Type::OrSymbol + ) + ).returns(T.attached_class) + end + def self.new(data:, type:) end - def self.new(data:, type:); end sig do - override - .returns( - {data: String, type: T.nilable(FinchAPI::Models::HRIS::Individual::UnionMember0::Email::Type::TaggedSymbol)} - ) + override.returns( + { + data: String, + type: + T.nilable( + FinchAPI::HRIS::Individual::UnionMember0::Email::Type::TaggedSymbol + ) + } + ) + end + def to_hash end - def to_hash; end module Type extend FinchAPI::Internal::Type::Enum TaggedSymbol = - T.type_alias { T.all(Symbol, FinchAPI::Models::HRIS::Individual::UnionMember0::Email::Type) } + T.type_alias do + T.all( + Symbol, + FinchAPI::HRIS::Individual::UnionMember0::Email::Type + ) + end OrSymbol = T.type_alias { T.any(Symbol, String) } - WORK = T.let(:work, FinchAPI::Models::HRIS::Individual::UnionMember0::Email::Type::TaggedSymbol) - PERSONAL = T.let(:personal, FinchAPI::Models::HRIS::Individual::UnionMember0::Email::Type::TaggedSymbol) + WORK = + T.let( + :work, + FinchAPI::HRIS::Individual::UnionMember0::Email::Type::TaggedSymbol + ) + PERSONAL = + T.let( + :personal, + FinchAPI::HRIS::Individual::UnionMember0::Email::Type::TaggedSymbol + ) - sig { override.returns(T::Array[FinchAPI::Models::HRIS::Individual::UnionMember0::Email::Type::TaggedSymbol]) } - def self.values; end + sig do + override.returns( + T::Array[ + FinchAPI::HRIS::Individual::UnionMember0::Email::Type::TaggedSymbol + ] + ) + end + def self.values + end end end end class BatchError < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + sig { returns(Float) } attr_accessor :code @@ -296,21 +488,28 @@ module FinchAPI attr_writer :finch_code sig do - params(code: Float, message: String, name: String, finch_code: String).returns(T.attached_class) + params( + code: Float, + message: String, + name: String, + finch_code: String + ).returns(T.attached_class) + end + def self.new(code:, message:, name:, finch_code: nil) end - def self.new(code:, message:, name:, finch_code: nil); end - sig { override.returns({code: Float, message: String, name: String, finch_code: String}) } - def to_hash; end + sig do + override.returns( + { code: Float, message: String, name: String, finch_code: String } + ) + end + def to_hash + end end - sig do - override - .returns( - [FinchAPI::Models::HRIS::Individual::UnionMember0, FinchAPI::Models::HRIS::Individual::BatchError] - ) + sig { override.returns(T::Array[FinchAPI::HRIS::Individual::Variants]) } + def self.variants end - def self.variants; end end end end diff --git a/rbi/finch_api/models/hris/individual_in_directory.rbi b/rbi/finch_api/models/hris/individual_in_directory.rbi index 139492e6..721abe37 100644 --- a/rbi/finch_api/models/hris/individual_in_directory.rbi +++ b/rbi/finch_api/models/hris/individual_in_directory.rbi @@ -4,19 +4,26 @@ module FinchAPI module Models module HRIS class IndividualInDirectory < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + # A stable Finch `id` (UUID v4) for an individual in the company. sig { returns(String) } attr_accessor :id # The department object. - sig { returns(T.nilable(FinchAPI::Models::HRIS::IndividualInDirectory::Department)) } + sig do + returns(T.nilable(FinchAPI::HRIS::IndividualInDirectory::Department)) + end attr_reader :department sig do params( - department: T.nilable(T.any(FinchAPI::Models::HRIS::IndividualInDirectory::Department, FinchAPI::Internal::AnyHash)) - ) - .void + department: + T.nilable( + FinchAPI::HRIS::IndividualInDirectory::Department::OrHash + ) + ).void end attr_writer :department @@ -33,14 +40,16 @@ module FinchAPI attr_accessor :last_name # The manager object. - sig { returns(T.nilable(FinchAPI::Models::HRIS::IndividualInDirectory::Manager)) } + sig do + returns(T.nilable(FinchAPI::HRIS::IndividualInDirectory::Manager)) + end attr_reader :manager sig do params( - manager: T.nilable(T.any(FinchAPI::Models::HRIS::IndividualInDirectory::Manager, FinchAPI::Internal::AnyHash)) - ) - .void + manager: + T.nilable(FinchAPI::HRIS::IndividualInDirectory::Manager::OrHash) + ).void end attr_writer :manager @@ -51,14 +60,17 @@ module FinchAPI sig do params( id: String, - department: T.nilable(T.any(FinchAPI::Models::HRIS::IndividualInDirectory::Department, FinchAPI::Internal::AnyHash)), + department: + T.nilable( + FinchAPI::HRIS::IndividualInDirectory::Department::OrHash + ), first_name: T.nilable(String), is_active: T.nilable(T::Boolean), last_name: T.nilable(String), - manager: T.nilable(T.any(FinchAPI::Models::HRIS::IndividualInDirectory::Manager, FinchAPI::Internal::AnyHash)), + manager: + T.nilable(FinchAPI::HRIS::IndividualInDirectory::Manager::OrHash), middle_name: T.nilable(String) - ) - .returns(T.attached_class) + ).returns(T.attached_class) end def self.new( # A stable Finch `id` (UUID v4) for an individual in the company. @@ -75,24 +87,31 @@ module FinchAPI manager:, # The legal middle name of the individual. middle_name: - ); end + ) + end + sig do - override - .returns( - { - id: String, - department: T.nilable(FinchAPI::Models::HRIS::IndividualInDirectory::Department), - first_name: T.nilable(String), - is_active: T.nilable(T::Boolean), - last_name: T.nilable(String), - manager: T.nilable(FinchAPI::Models::HRIS::IndividualInDirectory::Manager), - middle_name: T.nilable(String) - } - ) + override.returns( + { + id: String, + department: + T.nilable(FinchAPI::HRIS::IndividualInDirectory::Department), + first_name: T.nilable(String), + is_active: T.nilable(T::Boolean), + last_name: T.nilable(String), + manager: + T.nilable(FinchAPI::HRIS::IndividualInDirectory::Manager), + middle_name: T.nilable(String) + } + ) + end + def to_hash end - def to_hash; end class Department < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + # The name of the department. sig { returns(T.nilable(String)) } attr_accessor :name @@ -102,12 +121,18 @@ module FinchAPI def self.new( # The name of the department. name: nil - ); end - sig { override.returns({name: T.nilable(String)}) } - def to_hash; end + ) + end + + sig { override.returns({ name: T.nilable(String) }) } + def to_hash + end end class Manager < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + # A stable Finch `id` (UUID v4) for an individual in the company. sig { returns(String) } attr_accessor :id @@ -117,9 +142,12 @@ module FinchAPI def self.new( # A stable Finch `id` (UUID v4) for an individual in the company. id: - ); end - sig { override.returns({id: String}) } - def to_hash; end + ) + end + + sig { override.returns({ id: String }) } + def to_hash + end end end end diff --git a/rbi/finch_api/models/hris/individual_response.rbi b/rbi/finch_api/models/hris/individual_response.rbi index 791c5217..be05bb33 100644 --- a/rbi/finch_api/models/hris/individual_response.rbi +++ b/rbi/finch_api/models/hris/individual_response.rbi @@ -4,9 +4,15 @@ module FinchAPI module Models module HRIS class IndividualResponse < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + sig do returns( - T.any(FinchAPI::Models::HRIS::Individual::UnionMember0, FinchAPI::Models::HRIS::Individual::BatchError) + T.any( + FinchAPI::HRIS::Individual::UnionMember0, + FinchAPI::HRIS::Individual::BatchError + ) ) end attr_accessor :body @@ -19,29 +25,33 @@ module FinchAPI sig do params( - body: T.any( - FinchAPI::Models::HRIS::Individual::UnionMember0, - FinchAPI::Internal::AnyHash, - FinchAPI::Models::HRIS::Individual::BatchError - ), + body: + T.any( + FinchAPI::HRIS::Individual::UnionMember0::OrHash, + FinchAPI::HRIS::Individual::BatchError::OrHash + ), code: Integer, individual_id: String - ) - .returns(T.attached_class) + ).returns(T.attached_class) + end + def self.new(body:, code:, individual_id:) end - def self.new(body:, code:, individual_id:); end sig do - override - .returns( - { - body: T.any(FinchAPI::Models::HRIS::Individual::UnionMember0, FinchAPI::Models::HRIS::Individual::BatchError), - code: Integer, - individual_id: String - } - ) + override.returns( + { + body: + T.any( + FinchAPI::HRIS::Individual::UnionMember0, + FinchAPI::HRIS::Individual::BatchError + ), + code: Integer, + individual_id: String + } + ) + end + def to_hash end - def to_hash; end end end end diff --git a/rbi/finch_api/models/hris/individual_retrieve_many_params.rbi b/rbi/finch_api/models/hris/individual_retrieve_many_params.rbi index 348e9d97..44b5d135 100644 --- a/rbi/finch_api/models/hris/individual_retrieve_many_params.rbi +++ b/rbi/finch_api/models/hris/individual_retrieve_many_params.rbi @@ -7,55 +7,81 @@ module FinchAPI extend FinchAPI::Internal::Type::RequestParameters::Converter include FinchAPI::Internal::Type::RequestParameters - sig { returns(T.nilable(FinchAPI::Models::HRIS::IndividualRetrieveManyParams::Options)) } + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + + sig do + returns( + T.nilable(FinchAPI::HRIS::IndividualRetrieveManyParams::Options) + ) + end attr_reader :options sig do params( - options: T.nilable( - T.any(FinchAPI::Models::HRIS::IndividualRetrieveManyParams::Options, FinchAPI::Internal::AnyHash) - ) - ) - .void + options: + T.nilable( + FinchAPI::HRIS::IndividualRetrieveManyParams::Options::OrHash + ) + ).void end attr_writer :options - sig { returns(T.nilable(T::Array[FinchAPI::Models::HRIS::IndividualRetrieveManyParams::Request])) } + sig do + returns( + T.nilable( + T::Array[FinchAPI::HRIS::IndividualRetrieveManyParams::Request] + ) + ) + end attr_reader :requests sig do params( - requests: T::Array[T.any(FinchAPI::Models::HRIS::IndividualRetrieveManyParams::Request, FinchAPI::Internal::AnyHash)] - ) - .void + requests: + T::Array[ + FinchAPI::HRIS::IndividualRetrieveManyParams::Request::OrHash + ] + ).void end attr_writer :requests sig do params( - options: T.nilable( - T.any(FinchAPI::Models::HRIS::IndividualRetrieveManyParams::Options, FinchAPI::Internal::AnyHash) - ), - requests: T::Array[T.any(FinchAPI::Models::HRIS::IndividualRetrieveManyParams::Request, FinchAPI::Internal::AnyHash)], - request_options: T.any(FinchAPI::RequestOptions, FinchAPI::Internal::AnyHash) - ) - .returns(T.attached_class) + options: + T.nilable( + FinchAPI::HRIS::IndividualRetrieveManyParams::Options::OrHash + ), + requests: + T::Array[ + FinchAPI::HRIS::IndividualRetrieveManyParams::Request::OrHash + ], + request_options: FinchAPI::RequestOptions::OrHash + ).returns(T.attached_class) + end + def self.new(options: nil, requests: nil, request_options: {}) end - def self.new(options: nil, requests: nil, request_options: {}); end sig do - override - .returns( - { - options: T.nilable(FinchAPI::Models::HRIS::IndividualRetrieveManyParams::Options), - requests: T::Array[FinchAPI::Models::HRIS::IndividualRetrieveManyParams::Request], - request_options: FinchAPI::RequestOptions - } - ) + override.returns( + { + options: + T.nilable( + FinchAPI::HRIS::IndividualRetrieveManyParams::Options + ), + requests: + T::Array[FinchAPI::HRIS::IndividualRetrieveManyParams::Request], + request_options: FinchAPI::RequestOptions + } + ) + end + def to_hash end - def to_hash; end class Options < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + sig { returns(T.nilable(T::Array[String])) } attr_reader :include @@ -63,13 +89,18 @@ module FinchAPI attr_writer :include sig { params(include: T::Array[String]).returns(T.attached_class) } - def self.new(include: nil); end + def self.new(include: nil) + end - sig { override.returns({include: T::Array[String]}) } - def to_hash; end + sig { override.returns({ include: T::Array[String] }) } + def to_hash + end end class Request < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + sig { returns(T.nilable(String)) } attr_reader :individual_id @@ -77,10 +108,12 @@ module FinchAPI attr_writer :individual_id sig { params(individual_id: String).returns(T.attached_class) } - def self.new(individual_id: nil); end + def self.new(individual_id: nil) + end - sig { override.returns({individual_id: String}) } - def to_hash; end + sig { override.returns({ individual_id: String }) } + def to_hash + end end end end diff --git a/rbi/finch_api/models/hris/pay_statement.rbi b/rbi/finch_api/models/hris/pay_statement.rbi index ceeb2a50..9796bb09 100644 --- a/rbi/finch_api/models/hris/pay_statement.rbi +++ b/rbi/finch_api/models/hris/pay_statement.rbi @@ -4,21 +4,46 @@ module FinchAPI module Models module HRIS class PayStatement < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + # The array of earnings objects associated with this pay statement - sig { returns(T.nilable(T::Array[T.nilable(FinchAPI::Models::HRIS::PayStatement::Earning)])) } + sig do + returns( + T.nilable( + T::Array[T.nilable(FinchAPI::HRIS::PayStatement::Earning)] + ) + ) + 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)])) } + sig do + returns( + T.nilable( + T::Array[ + T.nilable(FinchAPI::HRIS::PayStatement::EmployeeDeduction) + ] + ) + ) + end attr_accessor :employee_deductions - sig { returns(T.nilable(T::Array[T.nilable(FinchAPI::Models::HRIS::PayStatement::EmployerContribution)])) } + sig do + returns( + T.nilable( + T::Array[ + T.nilable(FinchAPI::HRIS::PayStatement::EmployerContribution) + ] + ) + ) + end attr_accessor :employer_contributions - sig { returns(T.nilable(FinchAPI::Models::Money)) } + sig { returns(T.nilable(FinchAPI::Money)) } attr_reader :gross_pay - sig { params(gross_pay: T.nilable(T.any(FinchAPI::Models::Money, FinchAPI::Internal::AnyHash))).void } + sig { params(gross_pay: T.nilable(FinchAPI::Money::OrHash)).void } attr_writer :gross_pay # A stable Finch `id` (UUID v4) for an individual in the company @@ -28,18 +53,26 @@ module FinchAPI sig { params(individual_id: String).void } attr_writer :individual_id - sig { returns(T.nilable(FinchAPI::Models::Money)) } + sig { returns(T.nilable(FinchAPI::Money)) } attr_reader :net_pay - sig { params(net_pay: T.nilable(T.any(FinchAPI::Models::Money, FinchAPI::Internal::AnyHash))).void } + sig { params(net_pay: T.nilable(FinchAPI::Money::OrHash)).void } attr_writer :net_pay # The payment method. - sig { returns(T.nilable(FinchAPI::Models::HRIS::PayStatement::PaymentMethod::TaggedSymbol)) } + sig do + returns( + T.nilable(FinchAPI::HRIS::PayStatement::PaymentMethod::TaggedSymbol) + ) + 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)])) } + sig do + returns( + T.nilable(T::Array[T.nilable(FinchAPI::HRIS::PayStatement::Tax)]) + ) + end attr_accessor :taxes # The number of hours worked for this pay period @@ -47,31 +80,47 @@ module FinchAPI attr_accessor :total_hours # The type of the payment associated with the pay statement. - sig { returns(T.nilable(FinchAPI::Models::HRIS::PayStatement::Type::TaggedSymbol)) } + sig do + returns(T.nilable(FinchAPI::HRIS::PayStatement::Type::TaggedSymbol)) + end attr_accessor :type sig do params( - earnings: T.nilable( - T::Array[T.nilable(T.any(FinchAPI::Models::HRIS::PayStatement::Earning, FinchAPI::Internal::AnyHash))] - ), - employee_deductions: T.nilable( - T::Array[T.nilable(T.any(FinchAPI::Models::HRIS::PayStatement::EmployeeDeduction, FinchAPI::Internal::AnyHash))] - ), - employer_contributions: T.nilable( - T::Array[T.nilable(T.any(FinchAPI::Models::HRIS::PayStatement::EmployerContribution, FinchAPI::Internal::AnyHash))] - ), - gross_pay: T.nilable(T.any(FinchAPI::Models::Money, FinchAPI::Internal::AnyHash)), + earnings: + T.nilable( + T::Array[ + T.nilable(FinchAPI::HRIS::PayStatement::Earning::OrHash) + ] + ), + employee_deductions: + T.nilable( + T::Array[ + T.nilable( + FinchAPI::HRIS::PayStatement::EmployeeDeduction::OrHash + ) + ] + ), + employer_contributions: + T.nilable( + T::Array[ + T.nilable( + FinchAPI::HRIS::PayStatement::EmployerContribution::OrHash + ) + ] + ), + gross_pay: T.nilable(FinchAPI::Money::OrHash), individual_id: String, - net_pay: T.nilable(T.any(FinchAPI::Models::Money, FinchAPI::Internal::AnyHash)), - 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::Internal::AnyHash))] - ), + net_pay: T.nilable(FinchAPI::Money::OrHash), + payment_method: + T.nilable(FinchAPI::HRIS::PayStatement::PaymentMethod::OrSymbol), + taxes: + T.nilable( + T::Array[T.nilable(FinchAPI::HRIS::PayStatement::Tax::OrHash)] + ), total_hours: T.nilable(Float), - type: T.nilable(FinchAPI::Models::HRIS::PayStatement::Type::OrSymbol) - ) - .returns(T.attached_class) + type: T.nilable(FinchAPI::HRIS::PayStatement::Type::OrSymbol) + ).returns(T.attached_class) end def self.new( # The array of earnings objects associated with this pay statement @@ -91,39 +140,71 @@ module FinchAPI total_hours: nil, # The type of the payment associated with the pay statement. type: nil - ); end + ) + end + sig do - override - .returns( - { - 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), - individual_id: String, - net_pay: T.nilable(FinchAPI::Models::Money), - 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(FinchAPI::Models::HRIS::PayStatement::Type::TaggedSymbol) - } - ) + override.returns( + { + earnings: + T.nilable( + T::Array[T.nilable(FinchAPI::HRIS::PayStatement::Earning)] + ), + employee_deductions: + T.nilable( + T::Array[ + T.nilable(FinchAPI::HRIS::PayStatement::EmployeeDeduction) + ] + ), + employer_contributions: + T.nilable( + T::Array[ + T.nilable( + FinchAPI::HRIS::PayStatement::EmployerContribution + ) + ] + ), + gross_pay: T.nilable(FinchAPI::Money), + individual_id: String, + net_pay: T.nilable(FinchAPI::Money), + payment_method: + T.nilable( + FinchAPI::HRIS::PayStatement::PaymentMethod::TaggedSymbol + ), + taxes: + T.nilable( + T::Array[T.nilable(FinchAPI::HRIS::PayStatement::Tax)] + ), + total_hours: T.nilable(Float), + type: T.nilable(FinchAPI::HRIS::PayStatement::Type::TaggedSymbol) + } + ) + end + def to_hash end - def to_hash; end class Earning < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + # The earnings amount in cents. sig { returns(T.nilable(Integer)) } attr_accessor :amount - sig { returns(T.nilable(FinchAPI::Models::HRIS::PayStatement::Earning::Attributes)) } + sig do + returns( + T.nilable(FinchAPI::HRIS::PayStatement::Earning::Attributes) + ) + end attr_reader :attributes sig do params( - attributes: T.nilable(T.any(FinchAPI::Models::HRIS::PayStatement::Earning::Attributes, FinchAPI::Internal::AnyHash)) - ) - .void + attributes: + T.nilable( + FinchAPI::HRIS::PayStatement::Earning::Attributes::OrHash + ) + ).void end attr_writer :attributes @@ -141,19 +222,28 @@ module FinchAPI attr_accessor :name # The type of earning. - sig { returns(T.nilable(FinchAPI::Models::HRIS::PayStatement::Earning::Type::TaggedSymbol)) } + sig do + returns( + T.nilable( + FinchAPI::HRIS::PayStatement::Earning::Type::TaggedSymbol + ) + ) + end attr_accessor :type sig do params( amount: T.nilable(Integer), - attributes: T.nilable(T.any(FinchAPI::Models::HRIS::PayStatement::Earning::Attributes, FinchAPI::Internal::AnyHash)), + attributes: + T.nilable( + FinchAPI::HRIS::PayStatement::Earning::Attributes::OrHash + ), currency: T.nilable(String), hours: T.nilable(Float), name: T.nilable(String), - type: T.nilable(FinchAPI::Models::HRIS::PayStatement::Earning::Type::OrSymbol) - ) - .returns(T.attached_class) + type: + T.nilable(FinchAPI::HRIS::PayStatement::Earning::Type::OrSymbol) + ).returns(T.attached_class) end def self.new( # The earnings amount in cents. @@ -168,64 +258,104 @@ module FinchAPI name: nil, # The type of earning. type: nil - ); end + ) + end + sig do - override - .returns( - { - amount: T.nilable(Integer), - attributes: T.nilable(FinchAPI::Models::HRIS::PayStatement::Earning::Attributes), - currency: T.nilable(String), - hours: T.nilable(Float), - name: T.nilable(String), - type: T.nilable(FinchAPI::Models::HRIS::PayStatement::Earning::Type::TaggedSymbol) - } - ) + override.returns( + { + amount: T.nilable(Integer), + attributes: + T.nilable(FinchAPI::HRIS::PayStatement::Earning::Attributes), + currency: T.nilable(String), + hours: T.nilable(Float), + name: T.nilable(String), + type: + T.nilable( + FinchAPI::HRIS::PayStatement::Earning::Type::TaggedSymbol + ) + } + ) + end + def to_hash end - def to_hash; end class Attributes < FinchAPI::Internal::Type::BaseModel - sig { returns(T.nilable(FinchAPI::Models::HRIS::PayStatement::Earning::Attributes::Metadata)) } + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + + sig do + returns( + T.nilable( + FinchAPI::HRIS::PayStatement::Earning::Attributes::Metadata + ) + ) + end attr_reader :metadata sig do params( - metadata: T.any(FinchAPI::Models::HRIS::PayStatement::Earning::Attributes::Metadata, FinchAPI::Internal::AnyHash) - ) - .void + metadata: + FinchAPI::HRIS::PayStatement::Earning::Attributes::Metadata::OrHash + ).void end attr_writer :metadata sig do params( - metadata: T.any(FinchAPI::Models::HRIS::PayStatement::Earning::Attributes::Metadata, FinchAPI::Internal::AnyHash) - ) - .returns(T.attached_class) + metadata: + FinchAPI::HRIS::PayStatement::Earning::Attributes::Metadata::OrHash + ).returns(T.attached_class) + end + def self.new(metadata: nil) end - def self.new(metadata: nil); end - sig { override.returns({metadata: FinchAPI::Models::HRIS::PayStatement::Earning::Attributes::Metadata}) } - def to_hash; end + sig do + override.returns( + { + metadata: + FinchAPI::HRIS::PayStatement::Earning::Attributes::Metadata + } + ) + end + def to_hash + end class Metadata < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + # 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])) } + sig { returns(T.nilable(T::Hash[Symbol, T.nilable(T.anything)])) } attr_reader :metadata - sig { params(metadata: T::Hash[Symbol, T.anything]).void } + sig do + params(metadata: T::Hash[Symbol, T.nilable(T.anything)]).void + end attr_writer :metadata - sig { params(metadata: T::Hash[Symbol, T.anything]).returns(T.attached_class) } + sig do + params( + metadata: T::Hash[Symbol, T.nilable(T.anything)] + ).returns(T.attached_class) + end def self.new( # 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.). metadata: nil - ); end - sig { override.returns({metadata: T::Hash[Symbol, T.anything]}) } - def to_hash; end + ) + end + + sig do + override.returns( + { metadata: T::Hash[Symbol, T.nilable(T.anything)] } + ) + end + def to_hash + end end end @@ -233,44 +363,114 @@ module FinchAPI module Type extend FinchAPI::Internal::Type::Enum - TaggedSymbol = T.type_alias { T.all(Symbol, FinchAPI::Models::HRIS::PayStatement::Earning::Type) } + TaggedSymbol = + T.type_alias do + T.all(Symbol, FinchAPI::HRIS::PayStatement::Earning::Type) + end OrSymbol = T.type_alias { T.any(Symbol, String) } - 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) + SALARY = + T.let( + :salary, + FinchAPI::HRIS::PayStatement::Earning::Type::TaggedSymbol + ) + WAGE = + T.let( + :wage, + FinchAPI::HRIS::PayStatement::Earning::Type::TaggedSymbol + ) + REIMBURSEMENT = + T.let( + :reimbursement, + FinchAPI::HRIS::PayStatement::Earning::Type::TaggedSymbol + ) + OVERTIME = + T.let( + :overtime, + FinchAPI::HRIS::PayStatement::Earning::Type::TaggedSymbol + ) + SEVERANCE = + T.let( + :severance, + FinchAPI::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) - TYPE_1099 = T.let(:"1099", FinchAPI::Models::HRIS::PayStatement::Earning::Type::TaggedSymbol) - OTHER = T.let(:other, FinchAPI::Models::HRIS::PayStatement::Earning::Type::TaggedSymbol) - - sig { override.returns(T::Array[FinchAPI::Models::HRIS::PayStatement::Earning::Type::TaggedSymbol]) } - def self.values; end + T.let( + :double_overtime, + FinchAPI::HRIS::PayStatement::Earning::Type::TaggedSymbol + ) + PTO = + T.let( + :pto, + FinchAPI::HRIS::PayStatement::Earning::Type::TaggedSymbol + ) + SICK = + T.let( + :sick, + FinchAPI::HRIS::PayStatement::Earning::Type::TaggedSymbol + ) + BONUS = + T.let( + :bonus, + FinchAPI::HRIS::PayStatement::Earning::Type::TaggedSymbol + ) + COMMISSION = + T.let( + :commission, + FinchAPI::HRIS::PayStatement::Earning::Type::TaggedSymbol + ) + TIPS = + T.let( + :tips, + FinchAPI::HRIS::PayStatement::Earning::Type::TaggedSymbol + ) + TYPE_1099 = + T.let( + :"1099", + FinchAPI::HRIS::PayStatement::Earning::Type::TaggedSymbol + ) + OTHER = + T.let( + :other, + FinchAPI::HRIS::PayStatement::Earning::Type::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + FinchAPI::HRIS::PayStatement::Earning::Type::TaggedSymbol + ] + ) + end + def self.values + end end end class EmployeeDeduction < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + # The deduction amount in cents. sig { returns(T.nilable(Integer)) } attr_accessor :amount - sig { returns(T.nilable(FinchAPI::Models::HRIS::PayStatement::EmployeeDeduction::Attributes)) } + sig do + returns( + T.nilable( + FinchAPI::HRIS::PayStatement::EmployeeDeduction::Attributes + ) + ) + end attr_reader :attributes sig do params( - attributes: T.nilable( - T.any(FinchAPI::Models::HRIS::PayStatement::EmployeeDeduction::Attributes, FinchAPI::Internal::AnyHash) - ) - ) - .void + attributes: + T.nilable( + FinchAPI::HRIS::PayStatement::EmployeeDeduction::Attributes::OrHash + ) + ).void end attr_writer :attributes @@ -287,21 +487,21 @@ module FinchAPI attr_accessor :pre_tax # Type of benefit. - sig { returns(T.nilable(FinchAPI::Models::HRIS::BenefitType::TaggedSymbol)) } + sig { returns(T.nilable(FinchAPI::HRIS::BenefitType::TaggedSymbol)) } attr_accessor :type sig do params( amount: T.nilable(Integer), - attributes: T.nilable( - T.any(FinchAPI::Models::HRIS::PayStatement::EmployeeDeduction::Attributes, FinchAPI::Internal::AnyHash) - ), + attributes: + T.nilable( + FinchAPI::HRIS::PayStatement::EmployeeDeduction::Attributes::OrHash + ), currency: T.nilable(String), name: T.nilable(String), pre_tax: T.nilable(T::Boolean), - type: T.nilable(FinchAPI::Models::HRIS::BenefitType::OrSymbol) - ) - .returns(T.attached_class) + type: T.nilable(FinchAPI::HRIS::BenefitType::OrSymbol) + ).returns(T.attached_class) end def self.new( # The deduction amount in cents. @@ -315,91 +515,131 @@ module FinchAPI pre_tax: nil, # Type of benefit. type: nil - ); end + ) + end + sig do - override - .returns( - { - amount: T.nilable(Integer), - attributes: T.nilable(FinchAPI::Models::HRIS::PayStatement::EmployeeDeduction::Attributes), - currency: T.nilable(String), - name: T.nilable(String), - pre_tax: T.nilable(T::Boolean), - type: T.nilable(FinchAPI::Models::HRIS::BenefitType::TaggedSymbol) - } - ) + override.returns( + { + amount: T.nilable(Integer), + attributes: + T.nilable( + FinchAPI::HRIS::PayStatement::EmployeeDeduction::Attributes + ), + currency: T.nilable(String), + name: T.nilable(String), + pre_tax: T.nilable(T::Boolean), + type: T.nilable(FinchAPI::HRIS::BenefitType::TaggedSymbol) + } + ) + end + def to_hash end - def to_hash; end class Attributes < FinchAPI::Internal::Type::BaseModel - sig { returns(T.nilable(FinchAPI::Models::HRIS::PayStatement::EmployeeDeduction::Attributes::Metadata)) } - attr_reader :metadata + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } sig do - params( - metadata: T.any( - FinchAPI::Models::HRIS::PayStatement::EmployeeDeduction::Attributes::Metadata, - FinchAPI::Internal::AnyHash + returns( + T.nilable( + FinchAPI::HRIS::PayStatement::EmployeeDeduction::Attributes::Metadata ) ) - .void + end + attr_reader :metadata + + sig do + params( + metadata: + FinchAPI::HRIS::PayStatement::EmployeeDeduction::Attributes::Metadata::OrHash + ).void end attr_writer :metadata sig do params( - metadata: T.any( - FinchAPI::Models::HRIS::PayStatement::EmployeeDeduction::Attributes::Metadata, - FinchAPI::Internal::AnyHash - ) - ) - .returns(T.attached_class) + metadata: + FinchAPI::HRIS::PayStatement::EmployeeDeduction::Attributes::Metadata::OrHash + ).returns(T.attached_class) + end + def self.new(metadata: nil) end - def self.new(metadata: nil); end sig do - override.returns({metadata: FinchAPI::Models::HRIS::PayStatement::EmployeeDeduction::Attributes::Metadata}) + override.returns( + { + metadata: + FinchAPI::HRIS::PayStatement::EmployeeDeduction::Attributes::Metadata + } + ) + end + def to_hash end - def to_hash; end class Metadata < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + # 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])) } + sig { returns(T.nilable(T::Hash[Symbol, T.nilable(T.anything)])) } attr_reader :metadata - sig { params(metadata: T::Hash[Symbol, T.anything]).void } + sig do + params(metadata: T::Hash[Symbol, T.nilable(T.anything)]).void + end attr_writer :metadata - sig { params(metadata: T::Hash[Symbol, T.anything]).returns(T.attached_class) } + sig do + params( + metadata: T::Hash[Symbol, T.nilable(T.anything)] + ).returns(T.attached_class) + end def self.new( # 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.). metadata: nil - ); end - sig { override.returns({metadata: T::Hash[Symbol, T.anything]}) } - def to_hash; end + ) + end + + sig do + override.returns( + { metadata: T::Hash[Symbol, T.nilable(T.anything)] } + ) + end + def to_hash + end end end end class EmployerContribution < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + # The contribution amount in cents. sig { returns(T.nilable(Integer)) } attr_accessor :amount - sig { returns(T.nilable(FinchAPI::Models::HRIS::PayStatement::EmployerContribution::Attributes)) } + sig do + returns( + T.nilable( + FinchAPI::HRIS::PayStatement::EmployerContribution::Attributes + ) + ) + end attr_reader :attributes sig do params( - attributes: T.nilable( - T.any(FinchAPI::Models::HRIS::PayStatement::EmployerContribution::Attributes, FinchAPI::Internal::AnyHash) - ) - ) - .void + attributes: + T.nilable( + FinchAPI::HRIS::PayStatement::EmployerContribution::Attributes::OrHash + ) + ).void end attr_writer :attributes @@ -412,20 +652,20 @@ module FinchAPI attr_accessor :name # Type of benefit. - sig { returns(T.nilable(FinchAPI::Models::HRIS::BenefitType::TaggedSymbol)) } + sig { returns(T.nilable(FinchAPI::HRIS::BenefitType::TaggedSymbol)) } attr_accessor :type sig do params( amount: T.nilable(Integer), - attributes: T.nilable( - T.any(FinchAPI::Models::HRIS::PayStatement::EmployerContribution::Attributes, FinchAPI::Internal::AnyHash) - ), + attributes: + T.nilable( + FinchAPI::HRIS::PayStatement::EmployerContribution::Attributes::OrHash + ), currency: T.nilable(String), name: T.nilable(String), - type: T.nilable(FinchAPI::Models::HRIS::BenefitType::OrSymbol) - ) - .returns(T.attached_class) + type: T.nilable(FinchAPI::HRIS::BenefitType::OrSymbol) + ).returns(T.attached_class) end def self.new( # The contribution amount in cents. @@ -437,72 +677,102 @@ module FinchAPI name: nil, # Type of benefit. type: nil - ); end + ) + end + sig do - override - .returns( - { - amount: T.nilable(Integer), - attributes: T.nilable(FinchAPI::Models::HRIS::PayStatement::EmployerContribution::Attributes), - currency: T.nilable(String), - name: T.nilable(String), - type: T.nilable(FinchAPI::Models::HRIS::BenefitType::TaggedSymbol) - } - ) + override.returns( + { + amount: T.nilable(Integer), + attributes: + T.nilable( + FinchAPI::HRIS::PayStatement::EmployerContribution::Attributes + ), + currency: T.nilable(String), + name: T.nilable(String), + type: T.nilable(FinchAPI::HRIS::BenefitType::TaggedSymbol) + } + ) + end + def to_hash end - def to_hash; end class Attributes < FinchAPI::Internal::Type::BaseModel - sig { returns(T.nilable(FinchAPI::Models::HRIS::PayStatement::EmployerContribution::Attributes::Metadata)) } - attr_reader :metadata + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } sig do - params( - metadata: T.any( - FinchAPI::Models::HRIS::PayStatement::EmployerContribution::Attributes::Metadata, - FinchAPI::Internal::AnyHash + returns( + T.nilable( + FinchAPI::HRIS::PayStatement::EmployerContribution::Attributes::Metadata ) ) - .void + end + attr_reader :metadata + + sig do + params( + metadata: + FinchAPI::HRIS::PayStatement::EmployerContribution::Attributes::Metadata::OrHash + ).void end attr_writer :metadata sig do params( - metadata: T.any( - FinchAPI::Models::HRIS::PayStatement::EmployerContribution::Attributes::Metadata, - FinchAPI::Internal::AnyHash - ) - ) - .returns(T.attached_class) + metadata: + FinchAPI::HRIS::PayStatement::EmployerContribution::Attributes::Metadata::OrHash + ).returns(T.attached_class) + end + def self.new(metadata: nil) end - def self.new(metadata: nil); end sig do - override - .returns({metadata: FinchAPI::Models::HRIS::PayStatement::EmployerContribution::Attributes::Metadata}) + override.returns( + { + metadata: + FinchAPI::HRIS::PayStatement::EmployerContribution::Attributes::Metadata + } + ) + end + def to_hash end - def to_hash; end class Metadata < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + # 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])) } + sig { returns(T.nilable(T::Hash[Symbol, T.nilable(T.anything)])) } attr_reader :metadata - sig { params(metadata: T::Hash[Symbol, T.anything]).void } + sig do + params(metadata: T::Hash[Symbol, T.nilable(T.anything)]).void + end attr_writer :metadata - sig { params(metadata: T::Hash[Symbol, T.anything]).returns(T.attached_class) } + sig do + params( + metadata: T::Hash[Symbol, T.nilable(T.anything)] + ).returns(T.attached_class) + end def self.new( # 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.). metadata: nil - ); end - sig { override.returns({metadata: T::Hash[Symbol, T.anything]}) } - def to_hash; end + ) + end + + sig do + override.returns( + { metadata: T::Hash[Symbol, T.nilable(T.anything)] } + ) + end + def to_hash + end end end end @@ -511,30 +781,52 @@ module FinchAPI module PaymentMethod extend FinchAPI::Internal::Type::Enum - TaggedSymbol = T.type_alias { T.all(Symbol, FinchAPI::Models::HRIS::PayStatement::PaymentMethod) } + TaggedSymbol = + T.type_alias do + T.all(Symbol, FinchAPI::HRIS::PayStatement::PaymentMethod) + end OrSymbol = T.type_alias { T.any(Symbol, String) } - CHECK = T.let(:check, FinchAPI::Models::HRIS::PayStatement::PaymentMethod::TaggedSymbol) + CHECK = + T.let( + :check, + FinchAPI::HRIS::PayStatement::PaymentMethod::TaggedSymbol + ) DIRECT_DEPOSIT = - T.let(:direct_deposit, FinchAPI::Models::HRIS::PayStatement::PaymentMethod::TaggedSymbol) + T.let( + :direct_deposit, + FinchAPI::HRIS::PayStatement::PaymentMethod::TaggedSymbol + ) - sig { override.returns(T::Array[FinchAPI::Models::HRIS::PayStatement::PaymentMethod::TaggedSymbol]) } - def self.values; end + sig do + override.returns( + T::Array[ + FinchAPI::HRIS::PayStatement::PaymentMethod::TaggedSymbol + ] + ) + end + def self.values + end end class Tax < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + # The tax amount in cents. sig { returns(T.nilable(Integer)) } attr_accessor :amount - sig { returns(T.nilable(FinchAPI::Models::HRIS::PayStatement::Tax::Attributes)) } + sig do + returns(T.nilable(FinchAPI::HRIS::PayStatement::Tax::Attributes)) + end attr_reader :attributes sig do params( - attributes: T.nilable(T.any(FinchAPI::Models::HRIS::PayStatement::Tax::Attributes, FinchAPI::Internal::AnyHash)) - ) - .void + attributes: + T.nilable(FinchAPI::HRIS::PayStatement::Tax::Attributes::OrHash) + ).void end attr_writer :attributes @@ -551,19 +843,25 @@ module FinchAPI attr_accessor :name # The type of taxes. - sig { returns(T.nilable(FinchAPI::Models::HRIS::PayStatement::Tax::Type::TaggedSymbol)) } + sig do + returns( + T.nilable(FinchAPI::HRIS::PayStatement::Tax::Type::TaggedSymbol) + ) + end attr_accessor :type sig do params( amount: T.nilable(Integer), - attributes: T.nilable(T.any(FinchAPI::Models::HRIS::PayStatement::Tax::Attributes, FinchAPI::Internal::AnyHash)), + attributes: + T.nilable( + FinchAPI::HRIS::PayStatement::Tax::Attributes::OrHash + ), currency: T.nilable(String), employer: T.nilable(T::Boolean), name: T.nilable(String), - type: T.nilable(FinchAPI::Models::HRIS::PayStatement::Tax::Type::OrSymbol) - ) - .returns(T.attached_class) + type: T.nilable(FinchAPI::HRIS::PayStatement::Tax::Type::OrSymbol) + ).returns(T.attached_class) end def self.new( # The tax amount in cents. @@ -577,64 +875,104 @@ module FinchAPI name: nil, # The type of taxes. type: nil - ); end + ) + end + sig do - override - .returns( - { - amount: T.nilable(Integer), - attributes: T.nilable(FinchAPI::Models::HRIS::PayStatement::Tax::Attributes), - currency: T.nilable(String), - employer: T.nilable(T::Boolean), - name: T.nilable(String), - type: T.nilable(FinchAPI::Models::HRIS::PayStatement::Tax::Type::TaggedSymbol) - } - ) + override.returns( + { + amount: T.nilable(Integer), + attributes: + T.nilable(FinchAPI::HRIS::PayStatement::Tax::Attributes), + currency: T.nilable(String), + employer: T.nilable(T::Boolean), + name: T.nilable(String), + type: + T.nilable( + FinchAPI::HRIS::PayStatement::Tax::Type::TaggedSymbol + ) + } + ) + end + def to_hash end - def to_hash; end class Attributes < FinchAPI::Internal::Type::BaseModel - sig { returns(T.nilable(FinchAPI::Models::HRIS::PayStatement::Tax::Attributes::Metadata)) } + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + + sig do + returns( + T.nilable( + FinchAPI::HRIS::PayStatement::Tax::Attributes::Metadata + ) + ) + end attr_reader :metadata sig do params( - metadata: T.any(FinchAPI::Models::HRIS::PayStatement::Tax::Attributes::Metadata, FinchAPI::Internal::AnyHash) - ) - .void + metadata: + FinchAPI::HRIS::PayStatement::Tax::Attributes::Metadata::OrHash + ).void end attr_writer :metadata sig do params( - metadata: T.any(FinchAPI::Models::HRIS::PayStatement::Tax::Attributes::Metadata, FinchAPI::Internal::AnyHash) - ) - .returns(T.attached_class) + metadata: + FinchAPI::HRIS::PayStatement::Tax::Attributes::Metadata::OrHash + ).returns(T.attached_class) + end + def self.new(metadata: nil) end - def self.new(metadata: nil); end - sig { override.returns({metadata: FinchAPI::Models::HRIS::PayStatement::Tax::Attributes::Metadata}) } - def to_hash; end + sig do + override.returns( + { + metadata: + FinchAPI::HRIS::PayStatement::Tax::Attributes::Metadata + } + ) + end + def to_hash + end class Metadata < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + # 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])) } + sig { returns(T.nilable(T::Hash[Symbol, T.nilable(T.anything)])) } attr_reader :metadata - sig { params(metadata: T::Hash[Symbol, T.anything]).void } + sig do + params(metadata: T::Hash[Symbol, T.nilable(T.anything)]).void + end attr_writer :metadata - sig { params(metadata: T::Hash[Symbol, T.anything]).returns(T.attached_class) } + sig do + params( + metadata: T::Hash[Symbol, T.nilable(T.anything)] + ).returns(T.attached_class) + end def self.new( # 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.). metadata: nil - ); end - sig { override.returns({metadata: T::Hash[Symbol, T.anything]}) } - def to_hash; end + ) + end + + sig do + override.returns( + { metadata: T::Hash[Symbol, T.nilable(T.anything)] } + ) + end + def to_hash + end end end @@ -642,16 +980,40 @@ module FinchAPI module Type extend FinchAPI::Internal::Type::Enum - TaggedSymbol = T.type_alias { T.all(Symbol, FinchAPI::Models::HRIS::PayStatement::Tax::Type) } + TaggedSymbol = + T.type_alias do + T.all(Symbol, FinchAPI::HRIS::PayStatement::Tax::Type) + end OrSymbol = T.type_alias { T.any(Symbol, String) } - 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) + STATE = + T.let( + :state, + FinchAPI::HRIS::PayStatement::Tax::Type::TaggedSymbol + ) + FEDERAL = + T.let( + :federal, + FinchAPI::HRIS::PayStatement::Tax::Type::TaggedSymbol + ) + LOCAL = + T.let( + :local, + FinchAPI::HRIS::PayStatement::Tax::Type::TaggedSymbol + ) + FICA = + T.let( + :fica, + FinchAPI::HRIS::PayStatement::Tax::Type::TaggedSymbol + ) - sig { override.returns(T::Array[FinchAPI::Models::HRIS::PayStatement::Tax::Type::TaggedSymbol]) } - def self.values; end + sig do + override.returns( + T::Array[FinchAPI::HRIS::PayStatement::Tax::Type::TaggedSymbol] + ) + end + def self.values + end end end @@ -659,15 +1021,33 @@ module FinchAPI module Type extend FinchAPI::Internal::Type::Enum - TaggedSymbol = T.type_alias { T.all(Symbol, FinchAPI::Models::HRIS::PayStatement::Type) } + TaggedSymbol = + T.type_alias { T.all(Symbol, FinchAPI::HRIS::PayStatement::Type) } OrSymbol = T.type_alias { T.any(Symbol, String) } - 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) + REGULAR_PAYROLL = + T.let( + :regular_payroll, + FinchAPI::HRIS::PayStatement::Type::TaggedSymbol + ) + OFF_CYCLE_PAYROLL = + T.let( + :off_cycle_payroll, + FinchAPI::HRIS::PayStatement::Type::TaggedSymbol + ) + ONE_TIME_PAYMENT = + T.let( + :one_time_payment, + FinchAPI::HRIS::PayStatement::Type::TaggedSymbol + ) - sig { override.returns(T::Array[FinchAPI::Models::HRIS::PayStatement::Type::TaggedSymbol]) } - def self.values; end + sig do + override.returns( + T::Array[FinchAPI::HRIS::PayStatement::Type::TaggedSymbol] + ) + end + def self.values + end end end end diff --git a/rbi/finch_api/models/hris/pay_statement_response.rbi b/rbi/finch_api/models/hris/pay_statement_response.rbi index 45b4584a..815a7dea 100644 --- a/rbi/finch_api/models/hris/pay_statement_response.rbi +++ b/rbi/finch_api/models/hris/pay_statement_response.rbi @@ -4,10 +4,15 @@ module FinchAPI module Models module HRIS class PayStatementResponse < FinchAPI::Internal::Type::BaseModel - sig { returns(T.nilable(FinchAPI::Models::HRIS::PayStatementResponseBody)) } + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + + sig { returns(T.nilable(FinchAPI::HRIS::PayStatementResponseBody)) } attr_reader :body - sig { params(body: T.any(FinchAPI::Models::HRIS::PayStatementResponseBody, FinchAPI::Internal::AnyHash)).void } + sig do + params(body: FinchAPI::HRIS::PayStatementResponseBody::OrHash).void + end attr_writer :body sig { returns(T.nilable(Integer)) } @@ -24,19 +29,25 @@ module FinchAPI sig do params( - body: T.any(FinchAPI::Models::HRIS::PayStatementResponseBody, FinchAPI::Internal::AnyHash), + body: FinchAPI::HRIS::PayStatementResponseBody::OrHash, code: Integer, payment_id: String - ) - .returns(T.attached_class) + ).returns(T.attached_class) + end + def self.new(body: nil, code: nil, payment_id: nil) end - def self.new(body: nil, code: nil, payment_id: nil); end sig do - override - .returns({body: FinchAPI::Models::HRIS::PayStatementResponseBody, code: Integer, payment_id: String}) + override.returns( + { + body: FinchAPI::HRIS::PayStatementResponseBody, + code: Integer, + payment_id: String + } + ) + end + def to_hash end - def to_hash; end end end end diff --git a/rbi/finch_api/models/hris/pay_statement_response_body.rbi b/rbi/finch_api/models/hris/pay_statement_response_body.rbi index 49aa13ae..f1524235 100644 --- a/rbi/finch_api/models/hris/pay_statement_response_body.rbi +++ b/rbi/finch_api/models/hris/pay_statement_response_body.rbi @@ -4,41 +4,49 @@ module FinchAPI module Models module HRIS class PayStatementResponseBody < FinchAPI::Internal::Type::BaseModel - sig { returns(T.nilable(FinchAPI::Models::Paging)) } + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + + sig { returns(T.nilable(FinchAPI::Paging)) } attr_reader :paging - sig { params(paging: T.any(FinchAPI::Models::Paging, FinchAPI::Internal::AnyHash)).void } + sig { params(paging: FinchAPI::Paging::OrHash).void } attr_writer :paging # The array of pay statements for the current payment. - sig { returns(T.nilable(T::Array[FinchAPI::Models::HRIS::PayStatement])) } + sig { returns(T.nilable(T::Array[FinchAPI::HRIS::PayStatement])) } attr_reader :pay_statements sig do - params(pay_statements: T::Array[T.any(FinchAPI::Models::HRIS::PayStatement, FinchAPI::Internal::AnyHash)]) - .void + params( + pay_statements: T::Array[FinchAPI::HRIS::PayStatement::OrHash] + ).void end attr_writer :pay_statements sig do params( - paging: T.any(FinchAPI::Models::Paging, FinchAPI::Internal::AnyHash), - pay_statements: T::Array[T.any(FinchAPI::Models::HRIS::PayStatement, FinchAPI::Internal::AnyHash)] - ) - .returns(T.attached_class) + paging: FinchAPI::Paging::OrHash, + pay_statements: T::Array[FinchAPI::HRIS::PayStatement::OrHash] + ).returns(T.attached_class) end def self.new( paging: nil, # The array of pay statements for the current payment. pay_statements: nil - ); end + ) + end + sig do - override - .returns( - {paging: FinchAPI::Models::Paging, pay_statements: T::Array[FinchAPI::Models::HRIS::PayStatement]} - ) + override.returns( + { + paging: FinchAPI::Paging, + pay_statements: T::Array[FinchAPI::HRIS::PayStatement] + } + ) + end + def to_hash end - def to_hash; end end end end diff --git a/rbi/finch_api/models/hris/pay_statement_retrieve_many_params.rbi b/rbi/finch_api/models/hris/pay_statement_retrieve_many_params.rbi index 705f8db9..0e306b89 100644 --- a/rbi/finch_api/models/hris/pay_statement_retrieve_many_params.rbi +++ b/rbi/finch_api/models/hris/pay_statement_retrieve_many_params.rbi @@ -7,34 +7,51 @@ module FinchAPI extend FinchAPI::Internal::Type::RequestParameters::Converter include FinchAPI::Internal::Type::RequestParameters + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + # The array of batch requests. - sig { returns(T::Array[FinchAPI::Models::HRIS::PayStatementRetrieveManyParams::Request]) } + sig do + returns( + T::Array[FinchAPI::HRIS::PayStatementRetrieveManyParams::Request] + ) + end attr_accessor :requests sig do params( - requests: T::Array[T.any(FinchAPI::Models::HRIS::PayStatementRetrieveManyParams::Request, FinchAPI::Internal::AnyHash)], - request_options: T.any(FinchAPI::RequestOptions, FinchAPI::Internal::AnyHash) - ) - .returns(T.attached_class) + requests: + T::Array[ + FinchAPI::HRIS::PayStatementRetrieveManyParams::Request::OrHash + ], + request_options: FinchAPI::RequestOptions::OrHash + ).returns(T.attached_class) end def self.new( # The array of batch requests. requests:, request_options: {} - ); end + ) + end + sig do - override - .returns( - { - requests: T::Array[FinchAPI::Models::HRIS::PayStatementRetrieveManyParams::Request], - request_options: FinchAPI::RequestOptions - } - ) + override.returns( + { + requests: + T::Array[ + FinchAPI::HRIS::PayStatementRetrieveManyParams::Request + ], + request_options: FinchAPI::RequestOptions + } + ) + end + def to_hash end - def to_hash; end class Request < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + # A stable Finch `id` (UUID v4) for a payment. sig { returns(String) } attr_accessor :payment_id @@ -53,7 +70,11 @@ module FinchAPI sig { params(offset: Integer).void } attr_writer :offset - sig { params(payment_id: String, limit: Integer, offset: Integer).returns(T.attached_class) } + sig do + params(payment_id: String, limit: Integer, offset: Integer).returns( + T.attached_class + ) + end def self.new( # A stable Finch `id` (UUID v4) for a payment. payment_id:, @@ -61,9 +82,16 @@ module FinchAPI limit: nil, # Index to start from. offset: nil - ); end - sig { override.returns({payment_id: String, limit: Integer, offset: Integer}) } - def to_hash; end + ) + end + + sig do + override.returns( + { payment_id: String, limit: Integer, offset: Integer } + ) + end + def to_hash + end end end end diff --git a/rbi/finch_api/models/hris/payment.rbi b/rbi/finch_api/models/hris/payment.rbi index 916dc9b2..5ff791c5 100644 --- a/rbi/finch_api/models/hris/payment.rbi +++ b/rbi/finch_api/models/hris/payment.rbi @@ -4,6 +4,9 @@ module FinchAPI module Models module HRIS class Payment < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + # The unique id for the payment. sig { returns(T.nilable(String)) } attr_reader :id @@ -11,48 +14,54 @@ module FinchAPI sig { params(id: String).void } attr_writer :id - sig { returns(T.nilable(FinchAPI::Models::Money)) } + sig { returns(T.nilable(FinchAPI::Money)) } attr_reader :company_debit - sig { params(company_debit: T.nilable(T.any(FinchAPI::Models::Money, FinchAPI::Internal::AnyHash))).void } + sig { params(company_debit: T.nilable(FinchAPI::Money::OrHash)).void } attr_writer :company_debit sig { returns(T.nilable(String)) } attr_accessor :debit_date - sig { returns(T.nilable(FinchAPI::Models::Money)) } + sig { returns(T.nilable(FinchAPI::Money)) } attr_reader :employee_taxes - sig { params(employee_taxes: T.nilable(T.any(FinchAPI::Models::Money, FinchAPI::Internal::AnyHash))).void } + sig { params(employee_taxes: T.nilable(FinchAPI::Money::OrHash)).void } attr_writer :employee_taxes - sig { returns(T.nilable(FinchAPI::Models::Money)) } + sig { returns(T.nilable(FinchAPI::Money)) } attr_reader :employer_taxes - sig { params(employer_taxes: T.nilable(T.any(FinchAPI::Models::Money, FinchAPI::Internal::AnyHash))).void } + sig { params(employer_taxes: T.nilable(FinchAPI::Money::OrHash)).void } attr_writer :employer_taxes - sig { returns(T.nilable(FinchAPI::Models::Money)) } + sig { returns(T.nilable(FinchAPI::Money)) } attr_reader :gross_pay - sig { params(gross_pay: T.nilable(T.any(FinchAPI::Models::Money, FinchAPI::Internal::AnyHash))).void } + sig { params(gross_pay: T.nilable(FinchAPI::Money::OrHash)).void } attr_writer :gross_pay # Array of every individual on this payment. sig { returns(T.nilable(T::Array[String])) } attr_accessor :individual_ids - sig { returns(T.nilable(FinchAPI::Models::Money)) } + sig { returns(T.nilable(FinchAPI::Money)) } attr_reader :net_pay - sig { params(net_pay: T.nilable(T.any(FinchAPI::Models::Money, FinchAPI::Internal::AnyHash))).void } + sig { params(net_pay: T.nilable(FinchAPI::Money::OrHash)).void } attr_writer :net_pay sig { returns(T.nilable(String)) } attr_accessor :pay_date # List of pay frequencies associated with this payment. - sig { returns(T.nilable(T::Array[FinchAPI::Models::HRIS::Payment::PayFrequency::TaggedSymbol])) } + sig do + returns( + T.nilable( + T::Array[FinchAPI::HRIS::Payment::PayFrequency::TaggedSymbol] + ) + ) + end attr_accessor :pay_frequencies # Array of the Finch id (uuidv4) of every pay group associated with this payment. @@ -60,33 +69,34 @@ module FinchAPI attr_accessor :pay_group_ids # The pay period object. - sig { returns(T.nilable(FinchAPI::Models::HRIS::Payment::PayPeriod)) } + sig { returns(T.nilable(FinchAPI::HRIS::Payment::PayPeriod)) } attr_reader :pay_period sig do params( - pay_period: T.nilable(T.any(FinchAPI::Models::HRIS::Payment::PayPeriod, FinchAPI::Internal::AnyHash)) - ) - .void + pay_period: T.nilable(FinchAPI::HRIS::Payment::PayPeriod::OrHash) + ).void end attr_writer :pay_period sig do params( id: String, - company_debit: T.nilable(T.any(FinchAPI::Models::Money, FinchAPI::Internal::AnyHash)), + company_debit: T.nilable(FinchAPI::Money::OrHash), debit_date: T.nilable(String), - employee_taxes: T.nilable(T.any(FinchAPI::Models::Money, FinchAPI::Internal::AnyHash)), - employer_taxes: T.nilable(T.any(FinchAPI::Models::Money, FinchAPI::Internal::AnyHash)), - gross_pay: T.nilable(T.any(FinchAPI::Models::Money, FinchAPI::Internal::AnyHash)), + employee_taxes: T.nilable(FinchAPI::Money::OrHash), + employer_taxes: T.nilable(FinchAPI::Money::OrHash), + gross_pay: T.nilable(FinchAPI::Money::OrHash), individual_ids: T.nilable(T::Array[String]), - net_pay: T.nilable(T.any(FinchAPI::Models::Money, FinchAPI::Internal::AnyHash)), + net_pay: T.nilable(FinchAPI::Money::OrHash), pay_date: T.nilable(String), - pay_frequencies: T.nilable(T::Array[FinchAPI::Models::HRIS::Payment::PayFrequency::OrSymbol]), + pay_frequencies: + T.nilable( + T::Array[FinchAPI::HRIS::Payment::PayFrequency::OrSymbol] + ), pay_group_ids: T.nilable(T::Array[String]), - pay_period: T.nilable(T.any(FinchAPI::Models::HRIS::Payment::PayPeriod, FinchAPI::Internal::AnyHash)) - ) - .returns(T.attached_class) + pay_period: T.nilable(FinchAPI::HRIS::Payment::PayPeriod::OrHash) + ).returns(T.attached_class) end def self.new( # The unique id for the payment. @@ -106,49 +116,89 @@ module FinchAPI pay_group_ids: nil, # The pay period object. pay_period: nil - ); end + ) + end + sig do - override - .returns( - { - id: String, - company_debit: T.nilable(FinchAPI::Models::Money), - 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), - 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[FinchAPI::Models::HRIS::Payment::PayFrequency::TaggedSymbol]), - pay_group_ids: T.nilable(T::Array[String]), - pay_period: T.nilable(FinchAPI::Models::HRIS::Payment::PayPeriod) - } - ) + override.returns( + { + id: String, + company_debit: T.nilable(FinchAPI::Money), + debit_date: T.nilable(String), + employee_taxes: T.nilable(FinchAPI::Money), + employer_taxes: T.nilable(FinchAPI::Money), + gross_pay: T.nilable(FinchAPI::Money), + individual_ids: T.nilable(T::Array[String]), + net_pay: T.nilable(FinchAPI::Money), + pay_date: T.nilable(String), + pay_frequencies: + T.nilable( + T::Array[FinchAPI::HRIS::Payment::PayFrequency::TaggedSymbol] + ), + pay_group_ids: T.nilable(T::Array[String]), + pay_period: T.nilable(FinchAPI::HRIS::Payment::PayPeriod) + } + ) + end + def to_hash end - def to_hash; end module PayFrequency extend FinchAPI::Internal::Type::Enum - TaggedSymbol = T.type_alias { T.all(Symbol, FinchAPI::Models::HRIS::Payment::PayFrequency) } + TaggedSymbol = + T.type_alias do + T.all(Symbol, FinchAPI::HRIS::Payment::PayFrequency) + end OrSymbol = T.type_alias { T.any(Symbol, String) } - 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) - - sig { override.returns(T::Array[FinchAPI::Models::HRIS::Payment::PayFrequency::TaggedSymbol]) } - def self.values; end + ANNUALLY = + T.let( + :annually, + FinchAPI::HRIS::Payment::PayFrequency::TaggedSymbol + ) + SEMI_ANNUALLY = + T.let( + :semi_annually, + FinchAPI::HRIS::Payment::PayFrequency::TaggedSymbol + ) + QUARTERLY = + T.let( + :quarterly, + FinchAPI::HRIS::Payment::PayFrequency::TaggedSymbol + ) + MONTHLY = + T.let(:monthly, FinchAPI::HRIS::Payment::PayFrequency::TaggedSymbol) + SEMI_MONTHLY = + T.let( + :semi_monthly, + FinchAPI::HRIS::Payment::PayFrequency::TaggedSymbol + ) + BI_WEEKLY = + T.let( + :bi_weekly, + FinchAPI::HRIS::Payment::PayFrequency::TaggedSymbol + ) + WEEKLY = + T.let(:weekly, FinchAPI::HRIS::Payment::PayFrequency::TaggedSymbol) + DAILY = + T.let(:daily, FinchAPI::HRIS::Payment::PayFrequency::TaggedSymbol) + OTHER = + T.let(:other, FinchAPI::HRIS::Payment::PayFrequency::TaggedSymbol) + + sig do + override.returns( + T::Array[FinchAPI::HRIS::Payment::PayFrequency::TaggedSymbol] + ) + end + def self.values + end end class PayPeriod < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + sig { returns(T.nilable(String)) } attr_accessor :end_date @@ -156,11 +206,22 @@ module FinchAPI attr_accessor :start_date # 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 - - sig { override.returns({end_date: T.nilable(String), start_date: T.nilable(String)}) } - def to_hash; end + sig do + params( + end_date: T.nilable(String), + start_date: T.nilable(String) + ).returns(T.attached_class) + end + def self.new(end_date: nil, start_date: nil) + end + + sig do + override.returns( + { end_date: T.nilable(String), start_date: T.nilable(String) } + ) + end + def to_hash + end end end end diff --git a/rbi/finch_api/models/hris/payment_list_params.rbi b/rbi/finch_api/models/hris/payment_list_params.rbi index 2f72d87d..666ed0d8 100644 --- a/rbi/finch_api/models/hris/payment_list_params.rbi +++ b/rbi/finch_api/models/hris/payment_list_params.rbi @@ -7,6 +7,9 @@ module FinchAPI extend FinchAPI::Internal::Type::RequestParameters::Converter include FinchAPI::Internal::Type::RequestParameters + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + # The end date to retrieve payments by a company (inclusive) in `YYYY-MM-DD` # format. sig { returns(Date) } @@ -21,9 +24,8 @@ module FinchAPI params( end_date: Date, start_date: Date, - request_options: T.any(FinchAPI::RequestOptions, FinchAPI::Internal::AnyHash) - ) - .returns(T.attached_class) + request_options: FinchAPI::RequestOptions::OrHash + ).returns(T.attached_class) end def self.new( # The end date to retrieve payments by a company (inclusive) in `YYYY-MM-DD` @@ -33,11 +35,20 @@ module FinchAPI # format. start_date:, request_options: {} - ); end + ) + end + sig do - override.returns({end_date: Date, start_date: Date, request_options: FinchAPI::RequestOptions}) + override.returns( + { + end_date: Date, + start_date: Date, + request_options: FinchAPI::RequestOptions + } + ) + end + def to_hash end - def to_hash; end end end end diff --git a/rbi/finch_api/models/hris/support_per_benefit_type.rbi b/rbi/finch_api/models/hris/support_per_benefit_type.rbi index eeab979b..1f51d185 100644 --- a/rbi/finch_api/models/hris/support_per_benefit_type.rbi +++ b/rbi/finch_api/models/hris/support_per_benefit_type.rbi @@ -4,42 +4,48 @@ module FinchAPI module Models module HRIS class SupportPerBenefitType < FinchAPI::Internal::Type::BaseModel - sig { returns(T.nilable(FinchAPI::Models::OperationSupportMatrix)) } + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + + sig { returns(T.nilable(FinchAPI::OperationSupportMatrix)) } attr_reader :company_benefits sig do - params(company_benefits: T.any(FinchAPI::Models::OperationSupportMatrix, FinchAPI::Internal::AnyHash)).void + params( + company_benefits: FinchAPI::OperationSupportMatrix::OrHash + ).void end attr_writer :company_benefits - sig { returns(T.nilable(FinchAPI::Models::OperationSupportMatrix)) } + sig { returns(T.nilable(FinchAPI::OperationSupportMatrix)) } attr_reader :individual_benefits sig do - params(individual_benefits: T.any(FinchAPI::Models::OperationSupportMatrix, FinchAPI::Internal::AnyHash)) - .void + params( + individual_benefits: FinchAPI::OperationSupportMatrix::OrHash + ).void end attr_writer :individual_benefits sig do params( - company_benefits: T.any(FinchAPI::Models::OperationSupportMatrix, FinchAPI::Internal::AnyHash), - individual_benefits: T.any(FinchAPI::Models::OperationSupportMatrix, FinchAPI::Internal::AnyHash) - ) - .returns(T.attached_class) + company_benefits: FinchAPI::OperationSupportMatrix::OrHash, + individual_benefits: FinchAPI::OperationSupportMatrix::OrHash + ).returns(T.attached_class) + end + def self.new(company_benefits: nil, individual_benefits: nil) end - def self.new(company_benefits: nil, individual_benefits: nil); end sig do - override - .returns( - { - company_benefits: FinchAPI::Models::OperationSupportMatrix, - individual_benefits: FinchAPI::Models::OperationSupportMatrix - } - ) + override.returns( + { + company_benefits: FinchAPI::OperationSupportMatrix, + individual_benefits: FinchAPI::OperationSupportMatrix + } + ) + end + def to_hash end - def to_hash; end end end end diff --git a/rbi/finch_api/models/hris/supported_benefit.rbi b/rbi/finch_api/models/hris/supported_benefit.rbi index 61a8de11..561cded5 100644 --- a/rbi/finch_api/models/hris/supported_benefit.rbi +++ b/rbi/finch_api/models/hris/supported_benefit.rbi @@ -4,6 +4,9 @@ module FinchAPI module Models module HRIS class SupportedBenefit < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + # Whether the provider supports an annual maximum for this benefit. sig { returns(T.nilable(T::Boolean)) } attr_accessor :annual_maximum @@ -17,7 +20,13 @@ module FinchAPI # supported. sig do returns( - T.nilable(T::Array[T.nilable(FinchAPI::Models::HRIS::SupportedBenefit::CompanyContribution::OrSymbol)]) + T.nilable( + T::Array[ + T.nilable( + FinchAPI::HRIS::SupportedBenefit::CompanyContribution::OrSymbol + ) + ] + ) ) end attr_accessor :company_contribution @@ -29,23 +38,46 @@ module FinchAPI # supported. sig do returns( - T.nilable(T::Array[T.nilable(FinchAPI::Models::HRIS::SupportedBenefit::EmployeeDeduction::OrSymbol)]) + T.nilable( + T::Array[ + T.nilable( + FinchAPI::HRIS::SupportedBenefit::EmployeeDeduction::OrSymbol + ) + ] + ) ) 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::OrSymbol)])) } + sig do + returns( + T.nilable( + T::Array[T.nilable(FinchAPI::HRIS::BenefitFrequency::OrSymbol)] + ) + ) + end attr_reader :frequencies - sig { params(frequencies: T::Array[T.nilable(FinchAPI::Models::HRIS::BenefitFrequency::OrSymbol)]).void } + sig do + params( + frequencies: + T::Array[T.nilable(FinchAPI::HRIS::BenefitFrequency::OrSymbol)] + ).void + end 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. sig do returns( - T.nilable(T::Array[T.nilable(FinchAPI::Models::HRIS::SupportedBenefit::HsaContributionLimit::OrSymbol)]) + T.nilable( + T::Array[ + T.nilable( + FinchAPI::HRIS::SupportedBenefit::HsaContributionLimit::OrSymbol + ) + ] + ) ) end attr_accessor :hsa_contribution_limit @@ -54,13 +86,34 @@ 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::OrSymbol)]), + company_contribution: + T.nilable( + T::Array[ + T.nilable( + FinchAPI::HRIS::SupportedBenefit::CompanyContribution::OrSymbol + ) + ] + ), description: T.nilable(String), - 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)]) - ) - .returns(T.attached_class) + employee_deduction: + T.nilable( + T::Array[ + T.nilable( + FinchAPI::HRIS::SupportedBenefit::EmployeeDeduction::OrSymbol + ) + ] + ), + frequencies: + T::Array[T.nilable(FinchAPI::HRIS::BenefitFrequency::OrSymbol)], + hsa_contribution_limit: + T.nilable( + T::Array[ + T.nilable( + FinchAPI::HRIS::SupportedBenefit::HsaContributionLimit::OrSymbol + ) + ] + ) + ).returns(T.attached_class) end def self.new( # Whether the provider supports an annual maximum for this benefit. @@ -80,64 +133,144 @@ module FinchAPI # 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. hsa_contribution_limit: nil - ); end + ) + end + sig do - override - .returns( - { - 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::OrSymbol)]), - description: T.nilable(String), - 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)]) - } - ) + override.returns( + { + annual_maximum: T.nilable(T::Boolean), + catch_up: T.nilable(T::Boolean), + company_contribution: + T.nilable( + T::Array[ + T.nilable( + FinchAPI::HRIS::SupportedBenefit::CompanyContribution::OrSymbol + ) + ] + ), + description: T.nilable(String), + employee_deduction: + T.nilable( + T::Array[ + T.nilable( + FinchAPI::HRIS::SupportedBenefit::EmployeeDeduction::OrSymbol + ) + ] + ), + frequencies: + T::Array[T.nilable(FinchAPI::HRIS::BenefitFrequency::OrSymbol)], + hsa_contribution_limit: + T.nilable( + T::Array[ + T.nilable( + FinchAPI::HRIS::SupportedBenefit::HsaContributionLimit::OrSymbol + ) + ] + ) + } + ) + end + def to_hash end - def to_hash; end module CompanyContribution extend FinchAPI::Internal::Type::Enum TaggedSymbol = - T.type_alias { T.all(Symbol, FinchAPI::Models::HRIS::SupportedBenefit::CompanyContribution) } + T.type_alias do + T.all( + Symbol, + FinchAPI::HRIS::SupportedBenefit::CompanyContribution + ) + end OrSymbol = T.type_alias { T.any(Symbol, String) } - FIXED = T.let(:fixed, FinchAPI::Models::HRIS::SupportedBenefit::CompanyContribution::TaggedSymbol) - PERCENT = T.let(:percent, FinchAPI::Models::HRIS::SupportedBenefit::CompanyContribution::TaggedSymbol) + FIXED = + T.let( + :fixed, + FinchAPI::HRIS::SupportedBenefit::CompanyContribution::TaggedSymbol + ) + PERCENT = + T.let( + :percent, + FinchAPI::HRIS::SupportedBenefit::CompanyContribution::TaggedSymbol + ) - sig { override.returns(T::Array[FinchAPI::Models::HRIS::SupportedBenefit::CompanyContribution::TaggedSymbol]) } - def self.values; end + sig do + override.returns( + T::Array[ + FinchAPI::HRIS::SupportedBenefit::CompanyContribution::TaggedSymbol + ] + ) + end + def self.values + end end module EmployeeDeduction extend FinchAPI::Internal::Type::Enum TaggedSymbol = - T.type_alias { T.all(Symbol, FinchAPI::Models::HRIS::SupportedBenefit::EmployeeDeduction) } + T.type_alias do + T.all(Symbol, FinchAPI::HRIS::SupportedBenefit::EmployeeDeduction) + end OrSymbol = T.type_alias { T.any(Symbol, String) } - FIXED = T.let(:fixed, FinchAPI::Models::HRIS::SupportedBenefit::EmployeeDeduction::TaggedSymbol) - PERCENT = T.let(:percent, FinchAPI::Models::HRIS::SupportedBenefit::EmployeeDeduction::TaggedSymbol) + FIXED = + T.let( + :fixed, + FinchAPI::HRIS::SupportedBenefit::EmployeeDeduction::TaggedSymbol + ) + PERCENT = + T.let( + :percent, + FinchAPI::HRIS::SupportedBenefit::EmployeeDeduction::TaggedSymbol + ) - sig { override.returns(T::Array[FinchAPI::Models::HRIS::SupportedBenefit::EmployeeDeduction::TaggedSymbol]) } - def self.values; end + sig do + override.returns( + T::Array[ + FinchAPI::HRIS::SupportedBenefit::EmployeeDeduction::TaggedSymbol + ] + ) + end + def self.values + end end module HsaContributionLimit extend FinchAPI::Internal::Type::Enum TaggedSymbol = - T.type_alias { T.all(Symbol, FinchAPI::Models::HRIS::SupportedBenefit::HsaContributionLimit) } + T.type_alias do + T.all( + Symbol, + FinchAPI::HRIS::SupportedBenefit::HsaContributionLimit + ) + end OrSymbol = T.type_alias { T.any(Symbol, String) } INDIVIDUAL = - T.let(:individual, FinchAPI::Models::HRIS::SupportedBenefit::HsaContributionLimit::TaggedSymbol) - FAMILY = T.let(:family, FinchAPI::Models::HRIS::SupportedBenefit::HsaContributionLimit::TaggedSymbol) + T.let( + :individual, + FinchAPI::HRIS::SupportedBenefit::HsaContributionLimit::TaggedSymbol + ) + FAMILY = + T.let( + :family, + FinchAPI::HRIS::SupportedBenefit::HsaContributionLimit::TaggedSymbol + ) - sig { override.returns(T::Array[FinchAPI::Models::HRIS::SupportedBenefit::HsaContributionLimit::TaggedSymbol]) } - def self.values; end + sig do + override.returns( + T::Array[ + FinchAPI::HRIS::SupportedBenefit::HsaContributionLimit::TaggedSymbol + ] + ) + end + def self.values + end end end end diff --git a/rbi/finch_api/models/hris/update_company_benefit_response.rbi b/rbi/finch_api/models/hris/update_company_benefit_response.rbi index b14deafd..bd9f29fd 100644 --- a/rbi/finch_api/models/hris/update_company_benefit_response.rbi +++ b/rbi/finch_api/models/hris/update_company_benefit_response.rbi @@ -4,6 +4,9 @@ module FinchAPI module Models module HRIS class UpdateCompanyBenefitResponse < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + # The id of the benefit. sig { returns(String) } attr_accessor :benefit_id @@ -11,14 +14,19 @@ module FinchAPI sig { returns(String) } attr_accessor :job_id - sig { params(benefit_id: String, job_id: String).returns(T.attached_class) } + sig do + params(benefit_id: String, job_id: String).returns(T.attached_class) + end def self.new( # The id of the benefit. benefit_id:, job_id: - ); end - sig { override.returns({benefit_id: String, job_id: String}) } - def to_hash; end + ) + end + + sig { override.returns({ benefit_id: String, job_id: String }) } + def to_hash + end end end end diff --git a/rbi/finch_api/models/hris/w42005.rbi b/rbi/finch_api/models/hris/w42005.rbi index 7b45d542..14d586bd 100644 --- a/rbi/finch_api/models/hris/w42005.rbi +++ b/rbi/finch_api/models/hris/w42005.rbi @@ -4,18 +4,21 @@ module FinchAPI module Models module HRIS class W42005 < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + # Detailed information specific to the 2005 W4 form. - sig { returns(T.nilable(FinchAPI::Models::HRIS::W42005::Data)) } + sig { returns(T.nilable(FinchAPI::HRIS::W42005::Data)) } attr_reader :data - sig { params(data: T.any(FinchAPI::Models::HRIS::W42005::Data, FinchAPI::Internal::AnyHash)).void } + sig { params(data: FinchAPI::HRIS::W42005::Data::OrHash).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)) } + sig { returns(T.nilable(FinchAPI::HRIS::W42005::Type::TaggedSymbol)) } attr_reader :type - sig { params(type: FinchAPI::Models::HRIS::W42005::Type::OrSymbol).void } + sig { params(type: FinchAPI::HRIS::W42005::Type::OrSymbol).void } attr_writer :type # The tax year this W4 document applies to. @@ -26,11 +29,10 @@ module FinchAPI # filing status, dependents, and withholding details. sig do params( - data: T.any(FinchAPI::Models::HRIS::W42005::Data, FinchAPI::Internal::AnyHash), - type: FinchAPI::Models::HRIS::W42005::Type::OrSymbol, + data: FinchAPI::HRIS::W42005::Data::OrHash, + type: FinchAPI::HRIS::W42005::Type::OrSymbol, year: T.nilable(Float) - ) - .returns(T.attached_class) + ).returns(T.attached_class) end def self.new( # Detailed information specific to the 2005 W4 form. @@ -39,33 +41,52 @@ module FinchAPI type: nil, # The tax year this W4 document applies to. year: nil - ); end + ) + end + sig do - override - .returns( - { - data: FinchAPI::Models::HRIS::W42005::Data, - type: FinchAPI::Models::HRIS::W42005::Type::TaggedSymbol, - year: T.nilable(Float) - } - ) + override.returns( + { + data: FinchAPI::HRIS::W42005::Data, + type: FinchAPI::HRIS::W42005::Type::TaggedSymbol, + year: T.nilable(Float) + } + ) + end + def to_hash end - def to_hash; end class Data < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + # Additional withholding amount (in cents). sig { returns(T.nilable(Integer)) } attr_accessor :additional_withholding # Indicates exemption status from federal tax withholding. - sig { returns(T.nilable(FinchAPI::Models::HRIS::W42005::Data::Exemption::TaggedSymbol)) } + sig do + returns( + T.nilable(FinchAPI::HRIS::W42005::Data::Exemption::TaggedSymbol) + ) + end attr_reader :exemption - sig { params(exemption: FinchAPI::Models::HRIS::W42005::Data::Exemption::OrSymbol).void } + sig do + params( + exemption: FinchAPI::HRIS::W42005::Data::Exemption::OrSymbol + ).void + end attr_writer :exemption # The individual's filing status for tax purposes. - sig { returns(T.nilable(FinchAPI::Models::HRIS::W42005::Data::FilingStatus::TaggedSymbol)) } + sig do + returns( + T.nilable( + FinchAPI::HRIS::W42005::Data::FilingStatus::TaggedSymbol + ) + ) + end attr_accessor :filing_status # The unique identifier for the individual associated with this 2005 W4 form. @@ -83,12 +104,12 @@ module FinchAPI sig do params( additional_withholding: T.nilable(Integer), - exemption: FinchAPI::Models::HRIS::W42005::Data::Exemption::OrSymbol, - filing_status: T.nilable(FinchAPI::Models::HRIS::W42005::Data::FilingStatus::OrSymbol), + exemption: FinchAPI::HRIS::W42005::Data::Exemption::OrSymbol, + filing_status: + T.nilable(FinchAPI::HRIS::W42005::Data::FilingStatus::OrSymbol), individual_id: String, total_number_of_allowances: T.nilable(Integer) - ) - .returns(T.attached_class) + ).returns(T.attached_class) end def self.new( # Additional withholding amount (in cents). @@ -101,52 +122,92 @@ module FinchAPI individual_id: nil, # Total number of allowances claimed (in cents). total_number_of_allowances: nil - ); end + ) + end + sig do - override - .returns( - { - additional_withholding: T.nilable(Integer), - exemption: FinchAPI::Models::HRIS::W42005::Data::Exemption::TaggedSymbol, - filing_status: T.nilable(FinchAPI::Models::HRIS::W42005::Data::FilingStatus::TaggedSymbol), - individual_id: String, - total_number_of_allowances: T.nilable(Integer) - } - ) + override.returns( + { + additional_withholding: T.nilable(Integer), + exemption: + FinchAPI::HRIS::W42005::Data::Exemption::TaggedSymbol, + filing_status: + T.nilable( + FinchAPI::HRIS::W42005::Data::FilingStatus::TaggedSymbol + ), + individual_id: String, + total_number_of_allowances: T.nilable(Integer) + } + ) + end + def to_hash end - def to_hash; end # Indicates exemption status from federal tax withholding. module Exemption extend FinchAPI::Internal::Type::Enum - TaggedSymbol = T.type_alias { T.all(Symbol, FinchAPI::Models::HRIS::W42005::Data::Exemption) } + TaggedSymbol = + T.type_alias do + T.all(Symbol, FinchAPI::HRIS::W42005::Data::Exemption) + end OrSymbol = T.type_alias { T.any(Symbol, String) } - EXEMPT = T.let(:exempt, FinchAPI::Models::HRIS::W42005::Data::Exemption::TaggedSymbol) - NON_EXEMPT = T.let(:non_exempt, FinchAPI::Models::HRIS::W42005::Data::Exemption::TaggedSymbol) + EXEMPT = + T.let( + :exempt, + FinchAPI::HRIS::W42005::Data::Exemption::TaggedSymbol + ) + NON_EXEMPT = + T.let( + :non_exempt, + FinchAPI::HRIS::W42005::Data::Exemption::TaggedSymbol + ) - sig { override.returns(T::Array[FinchAPI::Models::HRIS::W42005::Data::Exemption::TaggedSymbol]) } - def self.values; end + sig do + override.returns( + T::Array[FinchAPI::HRIS::W42005::Data::Exemption::TaggedSymbol] + ) + end + def self.values + end end # The individual's filing status for tax purposes. module FilingStatus extend FinchAPI::Internal::Type::Enum - TaggedSymbol = T.type_alias { T.all(Symbol, FinchAPI::Models::HRIS::W42005::Data::FilingStatus) } + TaggedSymbol = + T.type_alias do + T.all(Symbol, FinchAPI::HRIS::W42005::Data::FilingStatus) + end OrSymbol = T.type_alias { T.any(Symbol, String) } - MARRIED = T.let(:married, FinchAPI::Models::HRIS::W42005::Data::FilingStatus::TaggedSymbol) + MARRIED = + T.let( + :married, + FinchAPI::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 + FinchAPI::HRIS::W42005::Data::FilingStatus::TaggedSymbol + ) + SINGLE = + T.let( + :single, + FinchAPI::HRIS::W42005::Data::FilingStatus::TaggedSymbol ) - SINGLE = T.let(:single, FinchAPI::Models::HRIS::W42005::Data::FilingStatus::TaggedSymbol) - sig { override.returns(T::Array[FinchAPI::Models::HRIS::W42005::Data::FilingStatus::TaggedSymbol]) } - def self.values; end + sig do + override.returns( + T::Array[ + FinchAPI::HRIS::W42005::Data::FilingStatus::TaggedSymbol + ] + ) + end + def self.values + end end end @@ -154,13 +215,19 @@ module FinchAPI module Type extend FinchAPI::Internal::Type::Enum - TaggedSymbol = T.type_alias { T.all(Symbol, FinchAPI::Models::HRIS::W42005::Type) } + TaggedSymbol = + T.type_alias { T.all(Symbol, FinchAPI::HRIS::W42005::Type) } OrSymbol = T.type_alias { T.any(Symbol, String) } - W4_2005 = T.let(:w4_2005, FinchAPI::Models::HRIS::W42005::Type::TaggedSymbol) + W4_2005 = T.let(:w4_2005, FinchAPI::HRIS::W42005::Type::TaggedSymbol) - sig { override.returns(T::Array[FinchAPI::Models::HRIS::W42005::Type::TaggedSymbol]) } - def self.values; end + sig do + override.returns( + T::Array[FinchAPI::HRIS::W42005::Type::TaggedSymbol] + ) + end + def self.values + end end end end diff --git a/rbi/finch_api/models/hris/w42020.rbi b/rbi/finch_api/models/hris/w42020.rbi index a54f9700..6d525adc 100644 --- a/rbi/finch_api/models/hris/w42020.rbi +++ b/rbi/finch_api/models/hris/w42020.rbi @@ -4,18 +4,21 @@ module FinchAPI module Models module HRIS class W42020 < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + # Detailed information specific to the 2020 W4 form. - sig { returns(T.nilable(FinchAPI::Models::HRIS::W42020::Data)) } + sig { returns(T.nilable(FinchAPI::HRIS::W42020::Data)) } attr_reader :data - sig { params(data: T.any(FinchAPI::Models::HRIS::W42020::Data, FinchAPI::Internal::AnyHash)).void } + sig { params(data: FinchAPI::HRIS::W42020::Data::OrHash).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)) } + sig { returns(T.nilable(FinchAPI::HRIS::W42020::Type::TaggedSymbol)) } attr_reader :type - sig { params(type: FinchAPI::Models::HRIS::W42020::Type::OrSymbol).void } + sig { params(type: FinchAPI::HRIS::W42020::Type::OrSymbol).void } attr_writer :type # The tax year this W4 document applies to. @@ -26,11 +29,10 @@ module FinchAPI # filing status, dependents, and withholding details. sig do params( - data: T.any(FinchAPI::Models::HRIS::W42020::Data, FinchAPI::Internal::AnyHash), - type: FinchAPI::Models::HRIS::W42020::Type::OrSymbol, + data: FinchAPI::HRIS::W42020::Data::OrHash, + type: FinchAPI::HRIS::W42020::Type::OrSymbol, year: T.nilable(Float) - ) - .returns(T.attached_class) + ).returns(T.attached_class) end def self.new( # Detailed information specific to the 2020 W4 form. @@ -39,20 +41,25 @@ module FinchAPI type: nil, # The tax year this W4 document applies to. year: nil - ); end + ) + end + sig do - override - .returns( - { - data: FinchAPI::Models::HRIS::W42020::Data, - type: FinchAPI::Models::HRIS::W42020::Type::TaggedSymbol, - year: T.nilable(Float) - } - ) + override.returns( + { + data: FinchAPI::HRIS::W42020::Data, + type: FinchAPI::HRIS::W42020::Type::TaggedSymbol, + year: T.nilable(Float) + } + ) + end + def to_hash end - def to_hash; end class Data < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + # Amount claimed for dependents other than qualifying children under 17 (in # cents). sig { returns(T.nilable(Integer)) } @@ -71,7 +78,13 @@ module FinchAPI attr_accessor :extra_withholding # The individual's filing status for tax purposes. - sig { returns(T.nilable(FinchAPI::Models::HRIS::W42020::Data::FilingStatus::TaggedSymbol)) } + sig do + returns( + T.nilable( + FinchAPI::HRIS::W42020::Data::FilingStatus::TaggedSymbol + ) + ) + end attr_accessor :filing_status # The unique identifier for the individual associated with this document. @@ -96,12 +109,12 @@ 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::OrSymbol), + filing_status: + T.nilable(FinchAPI::HRIS::W42020::Data::FilingStatus::OrSymbol), individual_id: String, other_income: T.nilable(Integer), total_claim_dependent_and_other_credits: T.nilable(Integer) - ) - .returns(T.attached_class) + ).returns(T.attached_class) end def self.new( # Amount claimed for dependents other than qualifying children under 17 (in @@ -121,46 +134,64 @@ module FinchAPI other_income: nil, # Total amount claimed for dependents and other credits (in cents). total_claim_dependent_and_other_credits: nil - ); end + ) + end + sig do - override - .returns( - { - amount_for_other_dependents: T.nilable(Integer), - 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), - individual_id: String, - other_income: T.nilable(Integer), - total_claim_dependent_and_other_credits: T.nilable(Integer) - } - ) + override.returns( + { + amount_for_other_dependents: T.nilable(Integer), + amount_for_qualifying_children_under_17: T.nilable(Integer), + deductions: T.nilable(Integer), + extra_withholding: T.nilable(Integer), + filing_status: + T.nilable( + FinchAPI::HRIS::W42020::Data::FilingStatus::TaggedSymbol + ), + individual_id: String, + other_income: T.nilable(Integer), + total_claim_dependent_and_other_credits: T.nilable(Integer) + } + ) + end + def to_hash end - def to_hash; end # The individual's filing status for tax purposes. module FilingStatus extend FinchAPI::Internal::Type::Enum - TaggedSymbol = T.type_alias { T.all(Symbol, FinchAPI::Models::HRIS::W42020::Data::FilingStatus) } + TaggedSymbol = + T.type_alias do + T.all(Symbol, FinchAPI::HRIS::W42020::Data::FilingStatus) + end OrSymbol = T.type_alias { T.any(Symbol, String) } HEAD_OF_HOUSEHOLD = - T.let(:head_of_household, FinchAPI::Models::HRIS::W42020::Data::FilingStatus::TaggedSymbol) + T.let( + :head_of_household, + FinchAPI::HRIS::W42020::Data::FilingStatus::TaggedSymbol + ) MARRIED_FILING_JOINTLY_OR_QUALIFYING_SURVIVING_SPOUSE = T.let( :married_filing_jointly_or_qualifying_surviving_spouse, - FinchAPI::Models::HRIS::W42020::Data::FilingStatus::TaggedSymbol + FinchAPI::HRIS::W42020::Data::FilingStatus::TaggedSymbol ) SINGLE_OR_MARRIED_FILING_SEPARATELY = T.let( :single_or_married_filing_separately, - FinchAPI::Models::HRIS::W42020::Data::FilingStatus::TaggedSymbol + FinchAPI::HRIS::W42020::Data::FilingStatus::TaggedSymbol ) - sig { override.returns(T::Array[FinchAPI::Models::HRIS::W42020::Data::FilingStatus::TaggedSymbol]) } - def self.values; end + sig do + override.returns( + T::Array[ + FinchAPI::HRIS::W42020::Data::FilingStatus::TaggedSymbol + ] + ) + end + def self.values + end end end @@ -168,13 +199,19 @@ module FinchAPI module Type extend FinchAPI::Internal::Type::Enum - TaggedSymbol = T.type_alias { T.all(Symbol, FinchAPI::Models::HRIS::W42020::Type) } + TaggedSymbol = + T.type_alias { T.all(Symbol, FinchAPI::HRIS::W42020::Type) } OrSymbol = T.type_alias { T.any(Symbol, String) } - W4_2020 = T.let(:w4_2020, FinchAPI::Models::HRIS::W42020::Type::TaggedSymbol) + W4_2020 = T.let(:w4_2020, FinchAPI::HRIS::W42020::Type::TaggedSymbol) - sig { override.returns(T::Array[FinchAPI::Models::HRIS::W42020::Type::TaggedSymbol]) } - def self.values; end + sig do + override.returns( + T::Array[FinchAPI::HRIS::W42020::Type::TaggedSymbol] + ) + end + def self.values + end end end end diff --git a/rbi/finch_api/models/income.rbi b/rbi/finch_api/models/income.rbi index da871030..ab6e2cad 100644 --- a/rbi/finch_api/models/income.rbi +++ b/rbi/finch_api/models/income.rbi @@ -3,6 +3,8 @@ module FinchAPI module Models class Income < FinchAPI::Internal::Type::BaseModel + OrHash = T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + # The income amount in cents. sig { returns(T.nilable(Integer)) } attr_accessor :amount @@ -17,7 +19,7 @@ module FinchAPI # 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)) } + sig { returns(T.nilable(FinchAPI::Income::Unit::OrSymbol)) } attr_accessor :unit # The employee's income as reported by the provider. This may not always be @@ -28,54 +30,57 @@ module FinchAPI amount: T.nilable(Integer), currency: T.nilable(String), effective_date: T.nilable(String), - unit: T.nilable(FinchAPI::Models::Income::Unit::OrSymbol) - ) - .returns(T.attached_class) + unit: T.nilable(FinchAPI::Income::Unit::OrSymbol) + ).returns(T.attached_class) end def self.new( # The income amount in cents. - amount: nil, + amount:, # The currency code. - currency: nil, + currency:, # The date the income amount went into effect. - effective_date: nil, + effective_date:, # The income unit of payment. Options: `yearly`, `quarterly`, `monthly`, # `semi_monthly`, `bi_weekly`, `weekly`, `daily`, `hourly`, and `fixed`. - unit: nil - ); end + unit: + ) + end + sig do - override - .returns( - { - amount: T.nilable(Integer), - currency: T.nilable(String), - effective_date: T.nilable(String), - unit: T.nilable(FinchAPI::Models::Income::Unit::OrSymbol) - } - ) + override.returns( + { + amount: T.nilable(Integer), + currency: T.nilable(String), + effective_date: T.nilable(String), + unit: T.nilable(FinchAPI::Income::Unit::OrSymbol) + } + ) + end + def to_hash end - def to_hash; end # The income unit of payment. Options: `yearly`, `quarterly`, `monthly`, # `semi_monthly`, `bi_weekly`, `weekly`, `daily`, `hourly`, and `fixed`. module Unit extend FinchAPI::Internal::Type::Enum - TaggedSymbol = T.type_alias { T.all(Symbol, FinchAPI::Models::Income::Unit) } + TaggedSymbol = T.type_alias { T.all(Symbol, FinchAPI::Income::Unit) } OrSymbol = T.type_alias { T.any(Symbol, String) } - 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) + YEARLY = T.let(:yearly, FinchAPI::Income::Unit::TaggedSymbol) + QUARTERLY = T.let(:quarterly, FinchAPI::Income::Unit::TaggedSymbol) + MONTHLY = T.let(:monthly, FinchAPI::Income::Unit::TaggedSymbol) + SEMI_MONTHLY = + T.let(:semi_monthly, FinchAPI::Income::Unit::TaggedSymbol) + BI_WEEKLY = T.let(:bi_weekly, FinchAPI::Income::Unit::TaggedSymbol) + WEEKLY = T.let(:weekly, FinchAPI::Income::Unit::TaggedSymbol) + DAILY = T.let(:daily, FinchAPI::Income::Unit::TaggedSymbol) + HOURLY = T.let(:hourly, FinchAPI::Income::Unit::TaggedSymbol) + FIXED = T.let(:fixed, FinchAPI::Income::Unit::TaggedSymbol) - sig { override.returns(T::Array[FinchAPI::Models::Income::Unit::TaggedSymbol]) } - def self.values; end + sig { override.returns(T::Array[FinchAPI::Income::Unit::TaggedSymbol]) } + def self.values + end end end end diff --git a/rbi/finch_api/models/individual_event.rbi b/rbi/finch_api/models/individual_event.rbi index 6f3e556e..faead1f2 100644 --- a/rbi/finch_api/models/individual_event.rbi +++ b/rbi/finch_api/models/individual_event.rbi @@ -3,39 +3,48 @@ module FinchAPI module Models class IndividualEvent < FinchAPI::Models::BaseWebhookEvent - sig { returns(T.nilable(FinchAPI::Models::IndividualEvent::Data)) } + OrHash = T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + + sig { returns(T.nilable(FinchAPI::IndividualEvent::Data)) } attr_reader :data - sig { params(data: T.any(FinchAPI::Models::IndividualEvent::Data, FinchAPI::Internal::AnyHash)).void } + sig { params(data: FinchAPI::IndividualEvent::Data::OrHash).void } attr_writer :data - sig { returns(T.nilable(FinchAPI::Models::IndividualEvent::EventType::TaggedSymbol)) } + sig do + returns(T.nilable(FinchAPI::IndividualEvent::EventType::TaggedSymbol)) + end attr_reader :event_type - sig { params(event_type: FinchAPI::Models::IndividualEvent::EventType::OrSymbol).void } + sig do + params(event_type: FinchAPI::IndividualEvent::EventType::OrSymbol).void + end attr_writer :event_type sig do params( - data: T.any(FinchAPI::Models::IndividualEvent::Data, FinchAPI::Internal::AnyHash), - event_type: FinchAPI::Models::IndividualEvent::EventType::OrSymbol - ) - .returns(T.attached_class) + data: FinchAPI::IndividualEvent::Data::OrHash, + event_type: FinchAPI::IndividualEvent::EventType::OrSymbol + ).returns(T.attached_class) + end + def self.new(data: nil, event_type: nil) end - def self.new(data: nil, event_type: nil); end sig do - override - .returns( - { - data: FinchAPI::Models::IndividualEvent::Data, - event_type: FinchAPI::Models::IndividualEvent::EventType::TaggedSymbol - } - ) + override.returns( + { + data: FinchAPI::IndividualEvent::Data, + event_type: FinchAPI::IndividualEvent::EventType::TaggedSymbol + } + ) + end + def to_hash end - def to_hash; end class Data < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + # The ID of the individual related to the event. sig { returns(T.nilable(String)) } attr_reader :individual_id @@ -47,26 +56,44 @@ module FinchAPI def self.new( # The ID of the individual related to the event. individual_id: nil - ); end - sig { override.returns({individual_id: String}) } - def to_hash; end + ) + end + + sig { override.returns({ individual_id: String }) } + def to_hash + end end module EventType extend FinchAPI::Internal::Type::Enum - TaggedSymbol = T.type_alias { T.all(Symbol, FinchAPI::Models::IndividualEvent::EventType) } + TaggedSymbol = + T.type_alias { T.all(Symbol, FinchAPI::IndividualEvent::EventType) } OrSymbol = T.type_alias { T.any(Symbol, String) } INDIVIDUAL_CREATED = - T.let(:"individual.created", FinchAPI::Models::IndividualEvent::EventType::TaggedSymbol) + T.let( + :"individual.created", + FinchAPI::IndividualEvent::EventType::TaggedSymbol + ) INDIVIDUAL_UPDATED = - T.let(:"individual.updated", FinchAPI::Models::IndividualEvent::EventType::TaggedSymbol) + T.let( + :"individual.updated", + FinchAPI::IndividualEvent::EventType::TaggedSymbol + ) INDIVIDUAL_DELETED = - T.let(:"individual.deleted", FinchAPI::Models::IndividualEvent::EventType::TaggedSymbol) + T.let( + :"individual.deleted", + FinchAPI::IndividualEvent::EventType::TaggedSymbol + ) - sig { override.returns(T::Array[FinchAPI::Models::IndividualEvent::EventType::TaggedSymbol]) } - def self.values; end + sig do + override.returns( + T::Array[FinchAPI::IndividualEvent::EventType::TaggedSymbol] + ) + end + def self.values + end end end end diff --git a/rbi/finch_api/models/introspection.rbi b/rbi/finch_api/models/introspection.rbi index 4aa1ccfd..081679f3 100644 --- a/rbi/finch_api/models/introspection.rbi +++ b/rbi/finch_api/models/introspection.rbi @@ -3,6 +3,8 @@ module FinchAPI module Models class Introspection < FinchAPI::Internal::Type::BaseModel + OrHash = T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + # The Finch UUID of the token being introspected. sig { returns(String) } attr_accessor :id @@ -12,7 +14,7 @@ module FinchAPI sig { returns(String) } attr_accessor :account_id - sig { returns(T::Array[FinchAPI::Models::Introspection::AuthenticationMethod]) } + sig { returns(T::Array[FinchAPI::Introspection::AuthenticationMethod]) } attr_accessor :authentication_methods # The client ID of the application associated with the `access_token`. @@ -20,7 +22,7 @@ module FinchAPI attr_accessor :client_id # The type of application associated with a token. - sig { returns(FinchAPI::Models::Introspection::ClientType::TaggedSymbol) } + sig { returns(FinchAPI::Introspection::ClientType::TaggedSymbol) } attr_accessor :client_type # [DEPRECATED] Use `connection_id` to associate tokens with a Finch connection @@ -32,14 +34,13 @@ module FinchAPI sig { returns(String) } attr_accessor :connection_id - sig { returns(FinchAPI::Models::Introspection::ConnectionStatus) } + sig { returns(FinchAPI::Introspection::ConnectionStatus) } attr_reader :connection_status sig do params( - connection_status: T.any(FinchAPI::Models::Introspection::ConnectionStatus, FinchAPI::Internal::AnyHash) - ) - .void + connection_status: FinchAPI::Introspection::ConnectionStatus::OrHash + ).void end attr_writer :connection_status @@ -47,7 +48,7 @@ module FinchAPI # # - `provider` - connection to an external provider # - `finch` - finch-generated data. - sig { returns(FinchAPI::Models::Introspection::ConnectionType::TaggedSymbol) } + sig { returns(FinchAPI::Introspection::ConnectionType::TaggedSymbol) } attr_accessor :connection_type # The email of your customer you provided to Finch when a connect session was @@ -92,13 +93,14 @@ module FinchAPI params( id: String, account_id: String, - authentication_methods: T::Array[T.any(FinchAPI::Models::Introspection::AuthenticationMethod, FinchAPI::Internal::AnyHash)], + authentication_methods: + T::Array[FinchAPI::Introspection::AuthenticationMethod::OrHash], client_id: String, - client_type: FinchAPI::Models::Introspection::ClientType::OrSymbol, + client_type: FinchAPI::Introspection::ClientType::OrSymbol, company_id: String, connection_id: String, - connection_status: T.any(FinchAPI::Models::Introspection::ConnectionStatus, FinchAPI::Internal::AnyHash), - connection_type: FinchAPI::Models::Introspection::ConnectionType::OrSymbol, + connection_status: FinchAPI::Introspection::ConnectionStatus::OrHash, + connection_type: FinchAPI::Introspection::ConnectionType::OrSymbol, customer_email: T.nilable(String), customer_id: T.nilable(String), customer_name: T.nilable(String), @@ -107,8 +109,7 @@ module FinchAPI products: T::Array[String], provider_id: String, username: String - ) - .returns(T.attached_class) + ).returns(T.attached_class) end def self.new( # The Finch UUID of the token being introspected. @@ -154,45 +155,55 @@ module FinchAPI provider_id:, # The account username used for login associated with the `access_token`. username: - ); end + ) + end + sig do - override - .returns( - { - id: String, - account_id: String, - authentication_methods: T::Array[FinchAPI::Models::Introspection::AuthenticationMethod], - client_id: String, - client_type: FinchAPI::Models::Introspection::ClientType::TaggedSymbol, - company_id: String, - connection_id: String, - connection_status: FinchAPI::Models::Introspection::ConnectionStatus, - connection_type: FinchAPI::Models::Introspection::ConnectionType::TaggedSymbol, - customer_email: T.nilable(String), - customer_id: T.nilable(String), - customer_name: T.nilable(String), - manual: T::Boolean, - payroll_provider_id: String, - products: T::Array[String], - provider_id: String, - username: String - } - ) + override.returns( + { + id: String, + account_id: String, + authentication_methods: + T::Array[FinchAPI::Introspection::AuthenticationMethod], + client_id: String, + client_type: FinchAPI::Introspection::ClientType::TaggedSymbol, + company_id: String, + connection_id: String, + connection_status: FinchAPI::Introspection::ConnectionStatus, + connection_type: + FinchAPI::Introspection::ConnectionType::TaggedSymbol, + customer_email: T.nilable(String), + customer_id: T.nilable(String), + customer_name: T.nilable(String), + manual: T::Boolean, + payroll_provider_id: String, + products: T::Array[String], + provider_id: String, + username: String + } + ) + end + def to_hash end - def to_hash; end class AuthenticationMethod < FinchAPI::Internal::Type::BaseModel - sig { returns(T.nilable(FinchAPI::Models::Introspection::AuthenticationMethod::ConnectionStatus)) } - attr_reader :connection_status + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } sig do - params( - connection_status: T.any( - FinchAPI::Models::Introspection::AuthenticationMethod::ConnectionStatus, - FinchAPI::Internal::AnyHash + returns( + T.nilable( + FinchAPI::Introspection::AuthenticationMethod::ConnectionStatus ) ) - .void + end + attr_reader :connection_status + + sig do + params( + connection_status: + FinchAPI::Introspection::AuthenticationMethod::ConnectionStatus::OrHash + ).void end attr_writer :connection_status @@ -204,22 +215,29 @@ module FinchAPI attr_writer :products # The type of authentication method. - sig { returns(T.nilable(FinchAPI::Models::Introspection::AuthenticationMethod::Type::TaggedSymbol)) } + sig do + returns( + T.nilable( + FinchAPI::Introspection::AuthenticationMethod::Type::TaggedSymbol + ) + ) + end attr_reader :type - sig { params(type: FinchAPI::Models::Introspection::AuthenticationMethod::Type::OrSymbol).void } + sig do + params( + type: FinchAPI::Introspection::AuthenticationMethod::Type::OrSymbol + ).void + end attr_writer :type sig do params( - connection_status: T.any( - FinchAPI::Models::Introspection::AuthenticationMethod::ConnectionStatus, - FinchAPI::Internal::AnyHash - ), + connection_status: + FinchAPI::Introspection::AuthenticationMethod::ConnectionStatus::OrHash, products: T::Array[String], - type: FinchAPI::Models::Introspection::AuthenticationMethod::Type::OrSymbol - ) - .returns(T.attached_class) + type: FinchAPI::Introspection::AuthenticationMethod::Type::OrSymbol + ).returns(T.attached_class) end def self.new( connection_status: nil, @@ -227,39 +245,60 @@ module FinchAPI products: nil, # The type of authentication method. type: nil - ); end + ) + end + sig do - override - .returns( - { - connection_status: FinchAPI::Models::Introspection::AuthenticationMethod::ConnectionStatus, - products: T::Array[String], - type: FinchAPI::Models::Introspection::AuthenticationMethod::Type::TaggedSymbol - } - ) + override.returns( + { + connection_status: + FinchAPI::Introspection::AuthenticationMethod::ConnectionStatus, + products: T::Array[String], + type: + FinchAPI::Introspection::AuthenticationMethod::Type::TaggedSymbol + } + ) + end + def to_hash end - def to_hash; end class ConnectionStatus < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + sig { returns(T.nilable(String)) } attr_reader :message sig { params(message: String).void } attr_writer :message - sig { returns(T.nilable(FinchAPI::Models::ConnectionStatusType::TaggedSymbol)) } + sig do + returns(T.nilable(FinchAPI::ConnectionStatusType::TaggedSymbol)) + end attr_reader :status - sig { params(status: FinchAPI::Models::ConnectionStatusType::OrSymbol).void } + sig { params(status: FinchAPI::ConnectionStatusType::OrSymbol).void } attr_writer :status sig do - params(message: String, status: FinchAPI::Models::ConnectionStatusType::OrSymbol).returns(T.attached_class) + params( + message: String, + status: FinchAPI::ConnectionStatusType::OrSymbol + ).returns(T.attached_class) + end + def self.new(message: nil, status: nil) end - def self.new(message: nil, status: nil); end - sig { override.returns({message: String, status: FinchAPI::Models::ConnectionStatusType::TaggedSymbol}) } - def to_hash; end + sig do + override.returns( + { + message: String, + status: FinchAPI::ConnectionStatusType::TaggedSymbol + } + ) + end + def to_hash + end end # The type of authentication method. @@ -267,19 +306,46 @@ module FinchAPI extend FinchAPI::Internal::Type::Enum TaggedSymbol = - T.type_alias { T.all(Symbol, FinchAPI::Models::Introspection::AuthenticationMethod::Type) } + T.type_alias do + T.all(Symbol, FinchAPI::Introspection::AuthenticationMethod::Type) + end OrSymbol = T.type_alias { T.any(Symbol, String) } - ASSISTED = T.let(:assisted, FinchAPI::Models::Introspection::AuthenticationMethod::Type::TaggedSymbol) + ASSISTED = + T.let( + :assisted, + FinchAPI::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) + T.let( + :credential, + FinchAPI::Introspection::AuthenticationMethod::Type::TaggedSymbol + ) + API_TOKEN = + T.let( + :api_token, + FinchAPI::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) + T.let( + :api_credential, + FinchAPI::Introspection::AuthenticationMethod::Type::TaggedSymbol + ) + OAUTH = + T.let( + :oauth, + FinchAPI::Introspection::AuthenticationMethod::Type::TaggedSymbol + ) - sig { override.returns(T::Array[FinchAPI::Models::Introspection::AuthenticationMethod::Type::TaggedSymbol]) } - def self.values; end + sig do + override.returns( + T::Array[ + FinchAPI::Introspection::AuthenticationMethod::Type::TaggedSymbol + ] + ) + end + def self.values + end end end @@ -287,18 +353,30 @@ module FinchAPI module ClientType extend FinchAPI::Internal::Type::Enum - TaggedSymbol = T.type_alias { T.all(Symbol, FinchAPI::Models::Introspection::ClientType) } + TaggedSymbol = + T.type_alias { T.all(Symbol, FinchAPI::Introspection::ClientType) } OrSymbol = T.type_alias { T.any(Symbol, String) } - 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) + PRODUCTION = + T.let(:production, FinchAPI::Introspection::ClientType::TaggedSymbol) + DEVELOPMENT = + T.let(:development, FinchAPI::Introspection::ClientType::TaggedSymbol) + SANDBOX = + T.let(:sandbox, FinchAPI::Introspection::ClientType::TaggedSymbol) - sig { override.returns(T::Array[FinchAPI::Models::Introspection::ClientType::TaggedSymbol]) } - def self.values; end + sig do + override.returns( + T::Array[FinchAPI::Introspection::ClientType::TaggedSymbol] + ) + end + def self.values + end end class ConnectionStatus < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + # The datetime when the connection was last successfully synced. sig { returns(T.nilable(Time)) } attr_reader :last_successful_sync @@ -312,33 +390,38 @@ module FinchAPI sig { params(message: String).void } attr_writer :message - sig { returns(T.nilable(FinchAPI::Models::ConnectionStatusType::TaggedSymbol)) } + sig { returns(T.nilable(FinchAPI::ConnectionStatusType::TaggedSymbol)) } attr_reader :status - sig { params(status: FinchAPI::Models::ConnectionStatusType::OrSymbol).void } + sig { params(status: FinchAPI::ConnectionStatusType::OrSymbol).void } attr_writer :status sig do params( last_successful_sync: Time, message: String, - status: FinchAPI::Models::ConnectionStatusType::OrSymbol - ) - .returns(T.attached_class) + status: FinchAPI::ConnectionStatusType::OrSymbol + ).returns(T.attached_class) end def self.new( # The datetime when the connection was last successfully synced. last_successful_sync: nil, message: nil, status: nil - ); end + ) + end + sig do - override - .returns( - {last_successful_sync: Time, message: String, status: FinchAPI::Models::ConnectionStatusType::TaggedSymbol} - ) + override.returns( + { + last_successful_sync: Time, + message: String, + status: FinchAPI::ConnectionStatusType::TaggedSymbol + } + ) + end + def to_hash end - def to_hash; end end # The type of the connection associated with the token. @@ -348,14 +431,27 @@ module FinchAPI module ConnectionType extend FinchAPI::Internal::Type::Enum - TaggedSymbol = T.type_alias { T.all(Symbol, FinchAPI::Models::Introspection::ConnectionType) } + TaggedSymbol = + T.type_alias do + T.all(Symbol, FinchAPI::Introspection::ConnectionType) + end OrSymbol = T.type_alias { T.any(Symbol, String) } - PROVIDER = T.let(:provider, FinchAPI::Models::Introspection::ConnectionType::TaggedSymbol) - FINCH = T.let(:finch, FinchAPI::Models::Introspection::ConnectionType::TaggedSymbol) + PROVIDER = + T.let( + :provider, + FinchAPI::Introspection::ConnectionType::TaggedSymbol + ) + FINCH = + T.let(:finch, FinchAPI::Introspection::ConnectionType::TaggedSymbol) - sig { override.returns(T::Array[FinchAPI::Models::Introspection::ConnectionType::TaggedSymbol]) } - def self.values; end + sig do + override.returns( + T::Array[FinchAPI::Introspection::ConnectionType::TaggedSymbol] + ) + end + def self.values + end end end end diff --git a/rbi/finch_api/models/job_completion_event.rbi b/rbi/finch_api/models/job_completion_event.rbi index 79ae71ea..d37b94ce 100644 --- a/rbi/finch_api/models/job_completion_event.rbi +++ b/rbi/finch_api/models/job_completion_event.rbi @@ -3,39 +3,52 @@ module FinchAPI module Models class JobCompletionEvent < FinchAPI::Models::BaseWebhookEvent - sig { returns(T.nilable(FinchAPI::Models::JobCompletionEvent::Data)) } + OrHash = T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + + sig { returns(T.nilable(FinchAPI::JobCompletionEvent::Data)) } attr_reader :data - sig { params(data: T.any(FinchAPI::Models::JobCompletionEvent::Data, FinchAPI::Internal::AnyHash)).void } + sig { params(data: FinchAPI::JobCompletionEvent::Data::OrHash).void } attr_writer :data - sig { returns(T.nilable(FinchAPI::Models::JobCompletionEvent::EventType::TaggedSymbol)) } + sig do + returns( + T.nilable(FinchAPI::JobCompletionEvent::EventType::TaggedSymbol) + ) + end attr_reader :event_type - sig { params(event_type: FinchAPI::Models::JobCompletionEvent::EventType::OrSymbol).void } + sig do + params( + event_type: FinchAPI::JobCompletionEvent::EventType::OrSymbol + ).void + end attr_writer :event_type sig do params( - data: T.any(FinchAPI::Models::JobCompletionEvent::Data, FinchAPI::Internal::AnyHash), - event_type: FinchAPI::Models::JobCompletionEvent::EventType::OrSymbol - ) - .returns(T.attached_class) + data: FinchAPI::JobCompletionEvent::Data::OrHash, + event_type: FinchAPI::JobCompletionEvent::EventType::OrSymbol + ).returns(T.attached_class) + end + def self.new(data: nil, event_type: nil) end - def self.new(data: nil, event_type: nil); end sig do - override - .returns( - { - data: FinchAPI::Models::JobCompletionEvent::Data, - event_type: FinchAPI::Models::JobCompletionEvent::EventType::TaggedSymbol - } - ) + override.returns( + { + data: FinchAPI::JobCompletionEvent::Data, + event_type: FinchAPI::JobCompletionEvent::EventType::TaggedSymbol + } + ) + end + def to_hash end - def to_hash; end class Data < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + # The id of the job which has completed. sig { returns(String) } attr_accessor :job_id @@ -44,38 +57,69 @@ module FinchAPI sig { returns(String) } attr_accessor :job_url - sig { params(job_id: String, job_url: String).returns(T.attached_class) } + sig do + params(job_id: String, job_url: String).returns(T.attached_class) + end def self.new( # The id of the job which has completed. job_id:, # The url to query the result of the job. job_url: - ); end - sig { override.returns({job_id: String, job_url: String}) } - def to_hash; end + ) + end + + sig { override.returns({ job_id: String, job_url: String }) } + def to_hash + end end module EventType extend FinchAPI::Internal::Type::Enum - TaggedSymbol = T.type_alias { T.all(Symbol, FinchAPI::Models::JobCompletionEvent::EventType) } + TaggedSymbol = + T.type_alias do + T.all(Symbol, FinchAPI::JobCompletionEvent::EventType) + end OrSymbol = T.type_alias { T.any(Symbol, String) } JOB_BENEFIT_CREATE_COMPLETED = - T.let(:"job.benefit_create.completed", FinchAPI::Models::JobCompletionEvent::EventType::TaggedSymbol) + T.let( + :"job.benefit_create.completed", + FinchAPI::JobCompletionEvent::EventType::TaggedSymbol + ) JOB_BENEFIT_ENROLL_COMPLETED = - T.let(:"job.benefit_enroll.completed", FinchAPI::Models::JobCompletionEvent::EventType::TaggedSymbol) + T.let( + :"job.benefit_enroll.completed", + FinchAPI::JobCompletionEvent::EventType::TaggedSymbol + ) JOB_BENEFIT_REGISTER_COMPLETED = - T.let(:"job.benefit_register.completed", FinchAPI::Models::JobCompletionEvent::EventType::TaggedSymbol) + T.let( + :"job.benefit_register.completed", + FinchAPI::JobCompletionEvent::EventType::TaggedSymbol + ) JOB_BENEFIT_UNENROLL_COMPLETED = - T.let(:"job.benefit_unenroll.completed", FinchAPI::Models::JobCompletionEvent::EventType::TaggedSymbol) + T.let( + :"job.benefit_unenroll.completed", + FinchAPI::JobCompletionEvent::EventType::TaggedSymbol + ) JOB_BENEFIT_UPDATE_COMPLETED = - T.let(:"job.benefit_update.completed", FinchAPI::Models::JobCompletionEvent::EventType::TaggedSymbol) + T.let( + :"job.benefit_update.completed", + FinchAPI::JobCompletionEvent::EventType::TaggedSymbol + ) JOB_DATA_SYNC_ALL_COMPLETED = - T.let(:"job.data_sync_all.completed", FinchAPI::Models::JobCompletionEvent::EventType::TaggedSymbol) + T.let( + :"job.data_sync_all.completed", + FinchAPI::JobCompletionEvent::EventType::TaggedSymbol + ) - sig { override.returns(T::Array[FinchAPI::Models::JobCompletionEvent::EventType::TaggedSymbol]) } - def self.values; end + sig do + override.returns( + T::Array[FinchAPI::JobCompletionEvent::EventType::TaggedSymbol] + ) + end + def self.values + end end end end diff --git a/rbi/finch_api/models/jobs/automated_async_job.rbi b/rbi/finch_api/models/jobs/automated_async_job.rbi index bd896185..b7fd553d 100644 --- a/rbi/finch_api/models/jobs/automated_async_job.rbi +++ b/rbi/finch_api/models/jobs/automated_async_job.rbi @@ -4,6 +4,9 @@ module FinchAPI module Models module Jobs class AutomatedAsyncJob < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + # The datetime the job completed. sig { returns(T.nilable(Time)) } attr_accessor :completed_at @@ -23,14 +26,13 @@ module FinchAPI attr_accessor :job_url # The input parameters for the job. - sig { returns(T.nilable(FinchAPI::Models::Jobs::AutomatedAsyncJob::Params)) } + sig { returns(T.nilable(FinchAPI::Jobs::AutomatedAsyncJob::Params)) } attr_reader :params sig do params( - params: T.nilable(T.any(FinchAPI::Models::Jobs::AutomatedAsyncJob::Params, FinchAPI::Internal::AnyHash)) - ) - .void + params: T.nilable(FinchAPI::Jobs::AutomatedAsyncJob::Params::OrHash) + ).void end attr_writer :params @@ -44,11 +46,11 @@ module FinchAPI sig { returns(T.nilable(Time)) } attr_accessor :started_at - sig { returns(FinchAPI::Models::Jobs::AutomatedAsyncJob::Status::TaggedSymbol) } + sig { returns(FinchAPI::Jobs::AutomatedAsyncJob::Status::TaggedSymbol) } attr_accessor :status # The type of automated job - sig { returns(FinchAPI::Models::Jobs::AutomatedAsyncJob::Type::TaggedSymbol) } + sig { returns(FinchAPI::Jobs::AutomatedAsyncJob::Type::TaggedSymbol) } attr_accessor :type sig do @@ -57,13 +59,13 @@ module FinchAPI created_at: Time, job_id: String, job_url: String, - params: T.nilable(T.any(FinchAPI::Models::Jobs::AutomatedAsyncJob::Params, FinchAPI::Internal::AnyHash)), + params: + T.nilable(FinchAPI::Jobs::AutomatedAsyncJob::Params::OrHash), scheduled_at: T.nilable(Time), started_at: T.nilable(Time), - status: FinchAPI::Models::Jobs::AutomatedAsyncJob::Status::OrSymbol, - type: FinchAPI::Models::Jobs::AutomatedAsyncJob::Type::OrSymbol - ) - .returns(T.attached_class) + status: FinchAPI::Jobs::AutomatedAsyncJob::Status::OrSymbol, + type: FinchAPI::Jobs::AutomatedAsyncJob::Type::OrSymbol + ).returns(T.attached_class) end def self.new( # The datetime the job completed. @@ -87,26 +89,31 @@ module FinchAPI status:, # The type of automated job type: - ); end + ) + end + sig do - override - .returns( - { - completed_at: T.nilable(Time), - created_at: Time, - job_id: String, - job_url: String, - params: T.nilable(FinchAPI::Models::Jobs::AutomatedAsyncJob::Params), - scheduled_at: T.nilable(Time), - started_at: T.nilable(Time), - status: FinchAPI::Models::Jobs::AutomatedAsyncJob::Status::TaggedSymbol, - type: FinchAPI::Models::Jobs::AutomatedAsyncJob::Type::TaggedSymbol - } - ) + override.returns( + { + completed_at: T.nilable(Time), + created_at: Time, + job_id: String, + job_url: String, + params: T.nilable(FinchAPI::Jobs::AutomatedAsyncJob::Params), + scheduled_at: T.nilable(Time), + started_at: T.nilable(Time), + status: FinchAPI::Jobs::AutomatedAsyncJob::Status::TaggedSymbol, + type: FinchAPI::Jobs::AutomatedAsyncJob::Type::TaggedSymbol + } + ) + end + def to_hash end - def to_hash; end class Params < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + # The ID of the individual that the job was completed for. sig { returns(T.nilable(String)) } attr_reader :individual_id @@ -119,42 +126,91 @@ module FinchAPI def self.new( # The ID of the individual that the job was completed for. individual_id: nil - ); end - sig { override.returns({individual_id: String}) } - def to_hash; end + ) + end + + sig { override.returns({ individual_id: String }) } + def to_hash + end end module Status extend FinchAPI::Internal::Type::Enum - TaggedSymbol = T.type_alias { T.all(Symbol, FinchAPI::Models::Jobs::AutomatedAsyncJob::Status) } + TaggedSymbol = + T.type_alias do + T.all(Symbol, FinchAPI::Jobs::AutomatedAsyncJob::Status) + end OrSymbol = T.type_alias { T.any(Symbol, String) } - 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) + PENDING = + T.let( + :pending, + FinchAPI::Jobs::AutomatedAsyncJob::Status::TaggedSymbol + ) + IN_PROGRESS = + T.let( + :in_progress, + FinchAPI::Jobs::AutomatedAsyncJob::Status::TaggedSymbol + ) + COMPLETE = + T.let( + :complete, + FinchAPI::Jobs::AutomatedAsyncJob::Status::TaggedSymbol + ) + ERROR = + T.let( + :error, + FinchAPI::Jobs::AutomatedAsyncJob::Status::TaggedSymbol + ) + REAUTH_ERROR = + T.let( + :reauth_error, + FinchAPI::Jobs::AutomatedAsyncJob::Status::TaggedSymbol + ) PERMISSIONS_ERROR = - T.let(:permissions_error, FinchAPI::Models::Jobs::AutomatedAsyncJob::Status::TaggedSymbol) + T.let( + :permissions_error, + FinchAPI::Jobs::AutomatedAsyncJob::Status::TaggedSymbol + ) - sig { override.returns(T::Array[FinchAPI::Models::Jobs::AutomatedAsyncJob::Status::TaggedSymbol]) } - def self.values; end + sig do + override.returns( + T::Array[FinchAPI::Jobs::AutomatedAsyncJob::Status::TaggedSymbol] + ) + end + def self.values + end end # The type of automated job module Type extend FinchAPI::Internal::Type::Enum - TaggedSymbol = T.type_alias { T.all(Symbol, FinchAPI::Models::Jobs::AutomatedAsyncJob::Type) } + TaggedSymbol = + T.type_alias do + T.all(Symbol, FinchAPI::Jobs::AutomatedAsyncJob::Type) + end OrSymbol = T.type_alias { T.any(Symbol, String) } - DATA_SYNC_ALL = T.let(:data_sync_all, FinchAPI::Models::Jobs::AutomatedAsyncJob::Type::TaggedSymbol) + DATA_SYNC_ALL = + T.let( + :data_sync_all, + FinchAPI::Jobs::AutomatedAsyncJob::Type::TaggedSymbol + ) W4_FORM_EMPLOYEE_SYNC = - T.let(:w4_form_employee_sync, FinchAPI::Models::Jobs::AutomatedAsyncJob::Type::TaggedSymbol) + T.let( + :w4_form_employee_sync, + FinchAPI::Jobs::AutomatedAsyncJob::Type::TaggedSymbol + ) - sig { override.returns(T::Array[FinchAPI::Models::Jobs::AutomatedAsyncJob::Type::TaggedSymbol]) } - def self.values; end + sig do + override.returns( + T::Array[FinchAPI::Jobs::AutomatedAsyncJob::Type::TaggedSymbol] + ) + end + def self.values + end end end end diff --git a/rbi/finch_api/models/jobs/automated_create_params.rbi b/rbi/finch_api/models/jobs/automated_create_params.rbi index d91f393b..2ffac899 100644 --- a/rbi/finch_api/models/jobs/automated_create_params.rbi +++ b/rbi/finch_api/models/jobs/automated_create_params.rbi @@ -7,60 +7,81 @@ module FinchAPI extend FinchAPI::Internal::Type::RequestParameters::Converter include FinchAPI::Internal::Type::RequestParameters + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + # The type of job to start. - sig { returns(FinchAPI::Models::Jobs::AutomatedCreateParams::Type::OrSymbol) } + sig { returns(FinchAPI::Jobs::AutomatedCreateParams::Type::OrSymbol) } attr_accessor :type - sig { returns(FinchAPI::Models::Jobs::AutomatedCreateParams::Params) } + sig { returns(FinchAPI::Jobs::AutomatedCreateParams::Params) } attr_reader :params sig do - params(params: T.any(FinchAPI::Models::Jobs::AutomatedCreateParams::Params, FinchAPI::Internal::AnyHash)) - .void + params( + params: FinchAPI::Jobs::AutomatedCreateParams::Params::OrHash + ).void end attr_writer :params sig do params( - type: FinchAPI::Models::Jobs::AutomatedCreateParams::Type::OrSymbol, - params: T.any(FinchAPI::Models::Jobs::AutomatedCreateParams::Params, FinchAPI::Internal::AnyHash), - request_options: T.any(FinchAPI::RequestOptions, FinchAPI::Internal::AnyHash) - ) - .returns(T.attached_class) + type: FinchAPI::Jobs::AutomatedCreateParams::Type::OrSymbol, + params: FinchAPI::Jobs::AutomatedCreateParams::Params::OrHash, + request_options: FinchAPI::RequestOptions::OrHash + ).returns(T.attached_class) end def self.new( # The type of job to start. type:, params:, request_options: {} - ); end + ) + end + sig do - override - .returns( - { - type: FinchAPI::Models::Jobs::AutomatedCreateParams::Type::OrSymbol, - params: FinchAPI::Models::Jobs::AutomatedCreateParams::Params, - request_options: FinchAPI::RequestOptions - } - ) + override.returns( + { + type: FinchAPI::Jobs::AutomatedCreateParams::Type::OrSymbol, + params: FinchAPI::Jobs::AutomatedCreateParams::Params, + request_options: FinchAPI::RequestOptions + } + ) + end + def to_hash end - def to_hash; end # The type of job to start. module Type extend FinchAPI::Internal::Type::Enum - TaggedSymbol = T.type_alias { T.all(Symbol, FinchAPI::Models::Jobs::AutomatedCreateParams::Type) } + TaggedSymbol = + T.type_alias do + T.all(Symbol, FinchAPI::Jobs::AutomatedCreateParams::Type) + end OrSymbol = T.type_alias { T.any(Symbol, String) } W4_FORM_EMPLOYEE_SYNC = - T.let(:w4_form_employee_sync, FinchAPI::Models::Jobs::AutomatedCreateParams::Type::TaggedSymbol) + T.let( + :w4_form_employee_sync, + FinchAPI::Jobs::AutomatedCreateParams::Type::TaggedSymbol + ) - sig { override.returns(T::Array[FinchAPI::Models::Jobs::AutomatedCreateParams::Type::TaggedSymbol]) } - def self.values; end + sig do + override.returns( + T::Array[ + FinchAPI::Jobs::AutomatedCreateParams::Type::TaggedSymbol + ] + ) + end + def self.values + end end class Params < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + # The unique ID of the individual for W-4 data sync. sig { returns(String) } attr_accessor :individual_id @@ -69,9 +90,12 @@ module FinchAPI def self.new( # The unique ID of the individual for W-4 data sync. individual_id: - ); end - sig { override.returns({individual_id: String}) } - def to_hash; end + ) + end + + sig { override.returns({ individual_id: String }) } + def to_hash + end end end end diff --git a/rbi/finch_api/models/jobs/automated_create_response.rbi b/rbi/finch_api/models/jobs/automated_create_response.rbi index 5fe8e92a..d2dca1bd 100644 --- a/rbi/finch_api/models/jobs/automated_create_response.rbi +++ b/rbi/finch_api/models/jobs/automated_create_response.rbi @@ -4,6 +4,9 @@ module FinchAPI module Models module Jobs class AutomatedCreateResponse < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + # The number of allowed refreshes per hour (per hour, fixed window) sig { returns(Integer) } attr_accessor :allowed_refreshes @@ -21,8 +24,12 @@ module FinchAPI attr_accessor :remaining_refreshes sig do - params(allowed_refreshes: Integer, job_id: String, job_url: String, remaining_refreshes: Integer) - .returns(T.attached_class) + params( + allowed_refreshes: Integer, + job_id: String, + job_url: String, + remaining_refreshes: Integer + ).returns(T.attached_class) end def self.new( # The number of allowed refreshes per hour (per hour, fixed window) @@ -33,17 +40,21 @@ module FinchAPI job_url:, # The number of remaining refreshes available (per hour, fixed window) remaining_refreshes: - ); end + ) + end + sig do - override - .returns({ - allowed_refreshes: Integer, - job_id: String, - job_url: String, - remaining_refreshes: Integer - }) + override.returns( + { + allowed_refreshes: Integer, + job_id: String, + job_url: String, + remaining_refreshes: Integer + } + ) + end + def to_hash end - def to_hash; end end end end diff --git a/rbi/finch_api/models/jobs/automated_list_params.rbi b/rbi/finch_api/models/jobs/automated_list_params.rbi index 9adb93fd..f95fa380 100644 --- a/rbi/finch_api/models/jobs/automated_list_params.rbi +++ b/rbi/finch_api/models/jobs/automated_list_params.rbi @@ -7,6 +7,9 @@ module FinchAPI extend FinchAPI::Internal::Type::RequestParameters::Converter include FinchAPI::Internal::Type::RequestParameters + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + # Number of items to return sig { returns(T.nilable(Integer)) } attr_reader :limit @@ -25,9 +28,8 @@ module FinchAPI params( limit: Integer, offset: Integer, - request_options: T.any(FinchAPI::RequestOptions, FinchAPI::Internal::AnyHash) - ) - .returns(T.attached_class) + request_options: FinchAPI::RequestOptions::OrHash + ).returns(T.attached_class) end def self.new( # Number of items to return @@ -35,9 +37,20 @@ module FinchAPI # Index to start from (defaults to 0) offset: nil, request_options: {} - ); end - sig { override.returns({limit: Integer, offset: Integer, request_options: FinchAPI::RequestOptions}) } - def to_hash; end + ) + end + + sig do + override.returns( + { + limit: Integer, + offset: Integer, + request_options: FinchAPI::RequestOptions + } + ) + end + def to_hash + end end end end diff --git a/rbi/finch_api/models/jobs/automated_list_response.rbi b/rbi/finch_api/models/jobs/automated_list_response.rbi index 805f1893..4e666677 100644 --- a/rbi/finch_api/models/jobs/automated_list_response.rbi +++ b/rbi/finch_api/models/jobs/automated_list_response.rbi @@ -4,56 +4,72 @@ module FinchAPI module Models module Jobs class AutomatedListResponse < FinchAPI::Internal::Type::BaseModel - sig { returns(T::Array[FinchAPI::Models::Jobs::AutomatedAsyncJob]) } + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + + sig { returns(T::Array[FinchAPI::Jobs::AutomatedAsyncJob]) } attr_accessor :data sig { returns(FinchAPI::Models::Jobs::AutomatedListResponse::Meta) } attr_reader :meta - sig { params(meta: T.any(FinchAPI::Models::Jobs::AutomatedListResponse::Meta, FinchAPI::Internal::AnyHash)).void } + sig do + params( + meta: FinchAPI::Models::Jobs::AutomatedListResponse::Meta::OrHash + ).void + end attr_writer :meta sig do params( - data: T::Array[T.any(FinchAPI::Models::Jobs::AutomatedAsyncJob, FinchAPI::Internal::AnyHash)], - meta: T.any(FinchAPI::Models::Jobs::AutomatedListResponse::Meta, FinchAPI::Internal::AnyHash) - ) - .returns(T.attached_class) + data: T::Array[FinchAPI::Jobs::AutomatedAsyncJob::OrHash], + meta: FinchAPI::Models::Jobs::AutomatedListResponse::Meta::OrHash + ).returns(T.attached_class) + end + def self.new(data:, meta:) end - def self.new(data:, meta:); end sig do - override - .returns( - { - data: T::Array[FinchAPI::Models::Jobs::AutomatedAsyncJob], - meta: FinchAPI::Models::Jobs::AutomatedListResponse::Meta - } - ) + override.returns( + { + data: T::Array[FinchAPI::Jobs::AutomatedAsyncJob], + meta: FinchAPI::Models::Jobs::AutomatedListResponse::Meta + } + ) + end + def to_hash end - def to_hash; end class Meta < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + # 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)) } + sig do + returns( + T.nilable( + FinchAPI::Models::Jobs::AutomatedListResponse::Meta::Quotas + ) + ) + end attr_reader :quotas sig do params( - quotas: T.any(FinchAPI::Models::Jobs::AutomatedListResponse::Meta::Quotas, FinchAPI::Internal::AnyHash) - ) - .void + quotas: + FinchAPI::Models::Jobs::AutomatedListResponse::Meta::Quotas::OrHash + ).void end attr_writer :quotas sig do params( - quotas: T.any(FinchAPI::Models::Jobs::AutomatedListResponse::Meta::Quotas, FinchAPI::Internal::AnyHash) - ) - .returns(T.attached_class) + quotas: + FinchAPI::Models::Jobs::AutomatedListResponse::Meta::Quotas::OrHash + ).returns(T.attached_class) end def self.new( # Information about remaining quotas for this connection. Only applicable for @@ -61,22 +77,38 @@ module FinchAPI # (`POST /jobs/automated`). Please contact a Finch representative for more # details. quotas: nil - ); end - sig { override.returns({quotas: FinchAPI::Models::Jobs::AutomatedListResponse::Meta::Quotas}) } - def to_hash; end + ) + end + + sig do + override.returns( + { + quotas: + FinchAPI::Models::Jobs::AutomatedListResponse::Meta::Quotas + } + ) + end + def to_hash + end class Quotas < FinchAPI::Internal::Type::BaseModel - sig { returns(T.nilable(FinchAPI::Models::Jobs::AutomatedListResponse::Meta::Quotas::DataSyncAll)) } - attr_reader :data_sync_all + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } sig do - params( - data_sync_all: T.any( - FinchAPI::Models::Jobs::AutomatedListResponse::Meta::Quotas::DataSyncAll, - FinchAPI::Internal::AnyHash + returns( + T.nilable( + FinchAPI::Models::Jobs::AutomatedListResponse::Meta::Quotas::DataSyncAll ) ) - .void + end + attr_reader :data_sync_all + + sig do + params( + data_sync_all: + FinchAPI::Models::Jobs::AutomatedListResponse::Meta::Quotas::DataSyncAll::OrHash + ).void end attr_writer :data_sync_all @@ -86,21 +118,28 @@ module FinchAPI # details. sig do params( - data_sync_all: T.any( - FinchAPI::Models::Jobs::AutomatedListResponse::Meta::Quotas::DataSyncAll, - FinchAPI::Internal::AnyHash - ) - ) - .returns(T.attached_class) + data_sync_all: + FinchAPI::Models::Jobs::AutomatedListResponse::Meta::Quotas::DataSyncAll::OrHash + ).returns(T.attached_class) + end + def self.new(data_sync_all: nil) end - def self.new(data_sync_all: nil); end sig do - override.returns({data_sync_all: FinchAPI::Models::Jobs::AutomatedListResponse::Meta::Quotas::DataSyncAll}) + override.returns( + { + data_sync_all: + FinchAPI::Models::Jobs::AutomatedListResponse::Meta::Quotas::DataSyncAll + } + ) + end + def to_hash end - def to_hash; end class DataSyncAll < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + sig { returns(T.nilable(Integer)) } attr_reader :allowed_refreshes @@ -114,12 +153,21 @@ module FinchAPI attr_writer :remaining_refreshes sig do - params(allowed_refreshes: Integer, remaining_refreshes: Integer).returns(T.attached_class) + params( + allowed_refreshes: Integer, + remaining_refreshes: Integer + ).returns(T.attached_class) + end + def self.new(allowed_refreshes: nil, remaining_refreshes: nil) end - def self.new(allowed_refreshes: nil, remaining_refreshes: nil); end - sig { override.returns({allowed_refreshes: Integer, remaining_refreshes: Integer}) } - def to_hash; end + sig do + override.returns( + { allowed_refreshes: Integer, remaining_refreshes: Integer } + ) + end + def to_hash + end end end end diff --git a/rbi/finch_api/models/jobs/automated_retrieve_params.rbi b/rbi/finch_api/models/jobs/automated_retrieve_params.rbi index 1f5982ad..8bcdcb4c 100644 --- a/rbi/finch_api/models/jobs/automated_retrieve_params.rbi +++ b/rbi/finch_api/models/jobs/automated_retrieve_params.rbi @@ -7,14 +7,20 @@ module FinchAPI extend FinchAPI::Internal::Type::RequestParameters::Converter include FinchAPI::Internal::Type::RequestParameters + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + sig do - params(request_options: T.any(FinchAPI::RequestOptions, FinchAPI::Internal::AnyHash)) - .returns(T.attached_class) + params(request_options: FinchAPI::RequestOptions::OrHash).returns( + T.attached_class + ) + end + def self.new(request_options: {}) end - def self.new(request_options: {}); end - sig { override.returns({request_options: FinchAPI::RequestOptions}) } - def to_hash; end + sig { override.returns({ request_options: FinchAPI::RequestOptions }) } + def to_hash + end end end end diff --git a/rbi/finch_api/models/jobs/manual_async_job.rbi b/rbi/finch_api/models/jobs/manual_async_job.rbi index b771145c..07c83796 100644 --- a/rbi/finch_api/models/jobs/manual_async_job.rbi +++ b/rbi/finch_api/models/jobs/manual_async_job.rbi @@ -4,6 +4,9 @@ module FinchAPI module Models module Jobs class ManualAsyncJob < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + # Specific information about the job, such as individual statuses for batch jobs. sig { returns(T.nilable(T::Array[T.anything])) } attr_accessor :body @@ -11,48 +14,70 @@ module FinchAPI sig { returns(String) } attr_accessor :job_id - sig { returns(FinchAPI::Models::Jobs::ManualAsyncJob::Status::TaggedSymbol) } + sig { returns(FinchAPI::Jobs::ManualAsyncJob::Status::TaggedSymbol) } attr_accessor :status sig do params( body: T.nilable(T::Array[T.anything]), job_id: String, - status: FinchAPI::Models::Jobs::ManualAsyncJob::Status::OrSymbol - ) - .returns(T.attached_class) + status: FinchAPI::Jobs::ManualAsyncJob::Status::OrSymbol + ).returns(T.attached_class) end def self.new( # Specific information about the job, such as individual statuses for batch jobs. body:, job_id:, status: - ); end + ) + end + sig do - override - .returns( - { - body: T.nilable(T::Array[T.anything]), - job_id: String, - status: FinchAPI::Models::Jobs::ManualAsyncJob::Status::TaggedSymbol - } - ) + override.returns( + { + body: T.nilable(T::Array[T.anything]), + job_id: String, + status: FinchAPI::Jobs::ManualAsyncJob::Status::TaggedSymbol + } + ) + end + def to_hash end - def to_hash; end module Status extend FinchAPI::Internal::Type::Enum - TaggedSymbol = T.type_alias { T.all(Symbol, FinchAPI::Models::Jobs::ManualAsyncJob::Status) } + TaggedSymbol = + T.type_alias do + T.all(Symbol, FinchAPI::Jobs::ManualAsyncJob::Status) + end OrSymbol = T.type_alias { T.any(Symbol, String) } - 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) + PENDING = + T.let( + :pending, + FinchAPI::Jobs::ManualAsyncJob::Status::TaggedSymbol + ) + IN_PROGRESS = + T.let( + :in_progress, + FinchAPI::Jobs::ManualAsyncJob::Status::TaggedSymbol + ) + ERROR = + T.let(:error, FinchAPI::Jobs::ManualAsyncJob::Status::TaggedSymbol) + COMPLETE = + T.let( + :complete, + FinchAPI::Jobs::ManualAsyncJob::Status::TaggedSymbol + ) - sig { override.returns(T::Array[FinchAPI::Models::Jobs::ManualAsyncJob::Status::TaggedSymbol]) } - def self.values; end + sig do + override.returns( + T::Array[FinchAPI::Jobs::ManualAsyncJob::Status::TaggedSymbol] + ) + end + def self.values + end end end end diff --git a/rbi/finch_api/models/jobs/manual_retrieve_params.rbi b/rbi/finch_api/models/jobs/manual_retrieve_params.rbi index 8ce3f6c1..3c3c7fae 100644 --- a/rbi/finch_api/models/jobs/manual_retrieve_params.rbi +++ b/rbi/finch_api/models/jobs/manual_retrieve_params.rbi @@ -7,14 +7,20 @@ module FinchAPI extend FinchAPI::Internal::Type::RequestParameters::Converter include FinchAPI::Internal::Type::RequestParameters + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + sig do - params(request_options: T.any(FinchAPI::RequestOptions, FinchAPI::Internal::AnyHash)) - .returns(T.attached_class) + params(request_options: FinchAPI::RequestOptions::OrHash).returns( + T.attached_class + ) + end + def self.new(request_options: {}) end - def self.new(request_options: {}); end - sig { override.returns({request_options: FinchAPI::RequestOptions}) } - def to_hash; end + sig { override.returns({ request_options: FinchAPI::RequestOptions }) } + def to_hash + end end end end diff --git a/rbi/finch_api/models/location.rbi b/rbi/finch_api/models/location.rbi index 2538e92e..2a98c0fd 100644 --- a/rbi/finch_api/models/location.rbi +++ b/rbi/finch_api/models/location.rbi @@ -3,6 +3,8 @@ module FinchAPI module Models class Location < FinchAPI::Internal::Type::BaseModel + OrHash = T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + # City, district, suburb, town, or village. sig { returns(T.nilable(String)) } attr_accessor :city @@ -43,8 +45,7 @@ module FinchAPI state: T.nilable(String), name: T.nilable(String), source_id: T.nilable(String) - ) - .returns(T.attached_class) + ).returns(T.attached_class) end def self.new( # City, district, suburb, town, or village. @@ -61,23 +62,25 @@ module FinchAPI state:, name: nil, source_id: nil - ); end + ) + end + sig do - override - .returns( - { - city: T.nilable(String), - country: T.nilable(String), - line1: T.nilable(String), - line2: T.nilable(String), - postal_code: T.nilable(String), - state: T.nilable(String), - name: T.nilable(String), - source_id: T.nilable(String) - } - ) + override.returns( + { + city: T.nilable(String), + country: T.nilable(String), + line1: T.nilable(String), + line2: T.nilable(String), + postal_code: T.nilable(String), + state: T.nilable(String), + name: T.nilable(String), + source_id: T.nilable(String) + } + ) + end + def to_hash end - def to_hash; end end end end diff --git a/rbi/finch_api/models/money.rbi b/rbi/finch_api/models/money.rbi index ac69e9d6..2ab196e5 100644 --- a/rbi/finch_api/models/money.rbi +++ b/rbi/finch_api/models/money.rbi @@ -3,6 +3,8 @@ module FinchAPI module Models class Money < FinchAPI::Internal::Type::BaseModel + OrHash = T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + # Amount for money object (in cents) sig { returns(T.nilable(Integer)) } attr_accessor :amount @@ -13,14 +15,21 @@ module FinchAPI sig { params(currency: String).void } attr_writer :currency - sig { params(amount: T.nilable(Integer), currency: String).returns(T.attached_class) } + sig do + params(amount: T.nilable(Integer), currency: String).returns( + T.attached_class + ) + end def self.new( # Amount for money object (in cents) amount: nil, currency: nil - ); end - sig { override.returns({amount: T.nilable(Integer), currency: String}) } - def to_hash; end + ) + end + + sig { override.returns({ amount: T.nilable(Integer), currency: String }) } + def to_hash + end end end end diff --git a/rbi/finch_api/models/operation_support.rbi b/rbi/finch_api/models/operation_support.rbi index ac4bb062..3479bf6b 100644 --- a/rbi/finch_api/models/operation_support.rbi +++ b/rbi/finch_api/models/operation_support.rbi @@ -12,17 +12,25 @@ module FinchAPI module OperationSupport extend FinchAPI::Internal::Type::Enum - TaggedSymbol = T.type_alias { T.all(Symbol, FinchAPI::Models::OperationSupport) } + TaggedSymbol = T.type_alias { T.all(Symbol, FinchAPI::OperationSupport) } OrSymbol = T.type_alias { T.any(Symbol, String) } - SUPPORTED = T.let(:supported, FinchAPI::Models::OperationSupport::TaggedSymbol) - NOT_SUPPORTED_BY_FINCH = T.let(:not_supported_by_finch, FinchAPI::Models::OperationSupport::TaggedSymbol) + SUPPORTED = T.let(:supported, FinchAPI::OperationSupport::TaggedSymbol) + NOT_SUPPORTED_BY_FINCH = + T.let(:not_supported_by_finch, FinchAPI::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) + T.let( + :not_supported_by_provider, + FinchAPI::OperationSupport::TaggedSymbol + ) + CLIENT_ACCESS_ONLY = + T.let(:client_access_only, FinchAPI::OperationSupport::TaggedSymbol) - sig { override.returns(T::Array[FinchAPI::Models::OperationSupport::TaggedSymbol]) } - def self.values; end + sig do + override.returns(T::Array[FinchAPI::OperationSupport::TaggedSymbol]) + end + def self.values + end end end end diff --git a/rbi/finch_api/models/operation_support_matrix.rbi b/rbi/finch_api/models/operation_support_matrix.rbi index 7cc5c414..509921da 100644 --- a/rbi/finch_api/models/operation_support_matrix.rbi +++ b/rbi/finch_api/models/operation_support_matrix.rbi @@ -3,6 +3,8 @@ module FinchAPI module Models class OperationSupportMatrix < FinchAPI::Internal::Type::BaseModel + OrHash = T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + # - `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 @@ -10,10 +12,10 @@ 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(FinchAPI::Models::OperationSupport::TaggedSymbol)) } + sig { returns(T.nilable(FinchAPI::OperationSupport::TaggedSymbol)) } attr_reader :create - sig { params(create: FinchAPI::Models::OperationSupport::OrSymbol).void } + sig { params(create: FinchAPI::OperationSupport::OrSymbol).void } attr_writer :create # - `supported`: This operation is supported by both the provider and Finch @@ -23,10 +25,10 @@ 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(FinchAPI::Models::OperationSupport::TaggedSymbol)) } + sig { returns(T.nilable(FinchAPI::OperationSupport::TaggedSymbol)) } attr_reader :delete - sig { params(delete: FinchAPI::Models::OperationSupport::OrSymbol).void } + sig { params(delete: FinchAPI::OperationSupport::OrSymbol).void } attr_writer :delete # - `supported`: This operation is supported by both the provider and Finch @@ -36,10 +38,10 @@ 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(FinchAPI::Models::OperationSupport::TaggedSymbol)) } + sig { returns(T.nilable(FinchAPI::OperationSupport::TaggedSymbol)) } attr_reader :read - sig { params(read: FinchAPI::Models::OperationSupport::OrSymbol).void } + sig { params(read: FinchAPI::OperationSupport::OrSymbol).void } attr_writer :read # - `supported`: This operation is supported by both the provider and Finch @@ -49,20 +51,19 @@ 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(FinchAPI::Models::OperationSupport::TaggedSymbol)) } + sig { returns(T.nilable(FinchAPI::OperationSupport::TaggedSymbol)) } attr_reader :update - sig { params(update: FinchAPI::Models::OperationSupport::OrSymbol).void } + sig { params(update: FinchAPI::OperationSupport::OrSymbol).void } attr_writer :update sig do params( - create: FinchAPI::Models::OperationSupport::OrSymbol, - delete: FinchAPI::Models::OperationSupport::OrSymbol, - read: FinchAPI::Models::OperationSupport::OrSymbol, - update: FinchAPI::Models::OperationSupport::OrSymbol - ) - .returns(T.attached_class) + create: FinchAPI::OperationSupport::OrSymbol, + delete: FinchAPI::OperationSupport::OrSymbol, + read: FinchAPI::OperationSupport::OrSymbol, + update: FinchAPI::OperationSupport::OrSymbol + ).returns(T.attached_class) end def self.new( # - `supported`: This operation is supported by both the provider and Finch @@ -97,19 +98,21 @@ module FinchAPI # - `client_access_only`: This behavior is supported by the provider, but only # available to the client and not to Finch update: nil - ); end + ) + end + sig do - override - .returns( - { - create: FinchAPI::Models::OperationSupport::TaggedSymbol, - delete: FinchAPI::Models::OperationSupport::TaggedSymbol, - read: FinchAPI::Models::OperationSupport::TaggedSymbol, - update: FinchAPI::Models::OperationSupport::TaggedSymbol - } - ) + override.returns( + { + create: FinchAPI::OperationSupport::TaggedSymbol, + delete: FinchAPI::OperationSupport::TaggedSymbol, + read: FinchAPI::OperationSupport::TaggedSymbol, + update: FinchAPI::OperationSupport::TaggedSymbol + } + ) + end + def to_hash end - def to_hash; end end end end diff --git a/rbi/finch_api/models/paging.rbi b/rbi/finch_api/models/paging.rbi index 3da75819..86906989 100644 --- a/rbi/finch_api/models/paging.rbi +++ b/rbi/finch_api/models/paging.rbi @@ -3,6 +3,8 @@ module FinchAPI module Models class Paging < FinchAPI::Internal::Type::BaseModel + OrHash = T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + # The current start index of the returned list of elements sig { returns(Integer) } attr_accessor :offset @@ -20,9 +22,12 @@ module FinchAPI offset:, # The total number of elements for the entire query (not just the given page) count: nil - ); end - sig { override.returns({offset: Integer, count: Integer}) } - def to_hash; end + ) + end + + sig { override.returns({ offset: Integer, count: Integer }) } + def to_hash + end end end end diff --git a/rbi/finch_api/models/pay_statement_event.rbi b/rbi/finch_api/models/pay_statement_event.rbi index 919d48b0..b74da438 100644 --- a/rbi/finch_api/models/pay_statement_event.rbi +++ b/rbi/finch_api/models/pay_statement_event.rbi @@ -3,39 +3,50 @@ module FinchAPI module Models class PayStatementEvent < FinchAPI::Models::BaseWebhookEvent - sig { returns(T.nilable(FinchAPI::Models::PayStatementEvent::Data)) } + OrHash = T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + + sig { returns(T.nilable(FinchAPI::PayStatementEvent::Data)) } attr_reader :data - sig { params(data: T.any(FinchAPI::Models::PayStatementEvent::Data, FinchAPI::Internal::AnyHash)).void } + sig { params(data: FinchAPI::PayStatementEvent::Data::OrHash).void } attr_writer :data - sig { returns(T.nilable(FinchAPI::Models::PayStatementEvent::EventType::TaggedSymbol)) } + sig do + returns(T.nilable(FinchAPI::PayStatementEvent::EventType::TaggedSymbol)) + end attr_reader :event_type - sig { params(event_type: FinchAPI::Models::PayStatementEvent::EventType::OrSymbol).void } + sig do + params( + event_type: FinchAPI::PayStatementEvent::EventType::OrSymbol + ).void + end attr_writer :event_type sig do params( - data: T.any(FinchAPI::Models::PayStatementEvent::Data, FinchAPI::Internal::AnyHash), - event_type: FinchAPI::Models::PayStatementEvent::EventType::OrSymbol - ) - .returns(T.attached_class) + data: FinchAPI::PayStatementEvent::Data::OrHash, + event_type: FinchAPI::PayStatementEvent::EventType::OrSymbol + ).returns(T.attached_class) + end + def self.new(data: nil, event_type: nil) end - def self.new(data: nil, event_type: nil); end sig do - override - .returns( - { - data: FinchAPI::Models::PayStatementEvent::Data, - event_type: FinchAPI::Models::PayStatementEvent::EventType::TaggedSymbol - } - ) + override.returns( + { + data: FinchAPI::PayStatementEvent::Data, + event_type: FinchAPI::PayStatementEvent::EventType::TaggedSymbol + } + ) + end + def to_hash end - def to_hash; end class Data < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + # The ID of the individual associated with the pay statement. sig { returns(T.nilable(String)) } attr_reader :individual_id @@ -50,32 +61,54 @@ module FinchAPI sig { params(payment_id: String).void } attr_writer :payment_id - sig { params(individual_id: String, payment_id: String).returns(T.attached_class) } + sig do + params(individual_id: String, payment_id: String).returns( + T.attached_class + ) + end def self.new( # The ID of the individual associated with the pay statement. individual_id: nil, # The ID of the payment associated with the pay statement. payment_id: nil - ); end - sig { override.returns({individual_id: String, payment_id: String}) } - def to_hash; end + ) + end + + sig { override.returns({ individual_id: String, payment_id: String }) } + def to_hash + end end module EventType extend FinchAPI::Internal::Type::Enum - TaggedSymbol = T.type_alias { T.all(Symbol, FinchAPI::Models::PayStatementEvent::EventType) } + TaggedSymbol = + T.type_alias { T.all(Symbol, FinchAPI::PayStatementEvent::EventType) } OrSymbol = T.type_alias { T.any(Symbol, String) } PAY_STATEMENT_CREATED = - T.let(:"pay_statement.created", FinchAPI::Models::PayStatementEvent::EventType::TaggedSymbol) + T.let( + :"pay_statement.created", + FinchAPI::PayStatementEvent::EventType::TaggedSymbol + ) PAY_STATEMENT_UPDATED = - T.let(:"pay_statement.updated", FinchAPI::Models::PayStatementEvent::EventType::TaggedSymbol) + T.let( + :"pay_statement.updated", + FinchAPI::PayStatementEvent::EventType::TaggedSymbol + ) PAY_STATEMENT_DELETED = - T.let(:"pay_statement.deleted", FinchAPI::Models::PayStatementEvent::EventType::TaggedSymbol) + T.let( + :"pay_statement.deleted", + FinchAPI::PayStatementEvent::EventType::TaggedSymbol + ) - sig { override.returns(T::Array[FinchAPI::Models::PayStatementEvent::EventType::TaggedSymbol]) } - def self.values; end + sig do + override.returns( + T::Array[FinchAPI::PayStatementEvent::EventType::TaggedSymbol] + ) + end + def self.values + end end end end diff --git a/rbi/finch_api/models/payment_event.rbi b/rbi/finch_api/models/payment_event.rbi index fcb2570e..ca98e852 100644 --- a/rbi/finch_api/models/payment_event.rbi +++ b/rbi/finch_api/models/payment_event.rbi @@ -3,39 +3,48 @@ module FinchAPI module Models class PaymentEvent < FinchAPI::Models::BaseWebhookEvent - sig { returns(T.nilable(FinchAPI::Models::PaymentEvent::Data)) } + OrHash = T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + + sig { returns(T.nilable(FinchAPI::PaymentEvent::Data)) } attr_reader :data - sig { params(data: T.any(FinchAPI::Models::PaymentEvent::Data, FinchAPI::Internal::AnyHash)).void } + sig { params(data: FinchAPI::PaymentEvent::Data::OrHash).void } attr_writer :data - sig { returns(T.nilable(FinchAPI::Models::PaymentEvent::EventType::TaggedSymbol)) } + sig do + returns(T.nilable(FinchAPI::PaymentEvent::EventType::TaggedSymbol)) + end attr_reader :event_type - sig { params(event_type: FinchAPI::Models::PaymentEvent::EventType::OrSymbol).void } + sig do + params(event_type: FinchAPI::PaymentEvent::EventType::OrSymbol).void + end attr_writer :event_type sig do params( - data: T.any(FinchAPI::Models::PaymentEvent::Data, FinchAPI::Internal::AnyHash), - event_type: FinchAPI::Models::PaymentEvent::EventType::OrSymbol - ) - .returns(T.attached_class) + data: FinchAPI::PaymentEvent::Data::OrHash, + event_type: FinchAPI::PaymentEvent::EventType::OrSymbol + ).returns(T.attached_class) + end + def self.new(data: nil, event_type: nil) end - def self.new(data: nil, event_type: nil); end sig do - override - .returns( - { - data: FinchAPI::Models::PaymentEvent::Data, - event_type: FinchAPI::Models::PaymentEvent::EventType::TaggedSymbol - } - ) + override.returns( + { + data: FinchAPI::PaymentEvent::Data, + event_type: FinchAPI::PaymentEvent::EventType::TaggedSymbol + } + ) + end + def to_hash end - def to_hash; end class Data < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + # The date of the payment. sig { returns(String) } attr_accessor :pay_date @@ -44,29 +53,52 @@ module FinchAPI sig { returns(String) } attr_accessor :payment_id - sig { params(pay_date: String, payment_id: String).returns(T.attached_class) } + sig do + params(pay_date: String, payment_id: String).returns(T.attached_class) + end def self.new( # The date of the payment. pay_date:, # The ID of the payment. payment_id: - ); end - sig { override.returns({pay_date: String, payment_id: String}) } - def to_hash; end + ) + end + + sig { override.returns({ pay_date: String, payment_id: String }) } + def to_hash + end end module EventType extend FinchAPI::Internal::Type::Enum - TaggedSymbol = T.type_alias { T.all(Symbol, FinchAPI::Models::PaymentEvent::EventType) } + TaggedSymbol = + T.type_alias { T.all(Symbol, FinchAPI::PaymentEvent::EventType) } OrSymbol = T.type_alias { T.any(Symbol, String) } - 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) + PAYMENT_CREATED = + T.let( + :"payment.created", + FinchAPI::PaymentEvent::EventType::TaggedSymbol + ) + PAYMENT_UPDATED = + T.let( + :"payment.updated", + FinchAPI::PaymentEvent::EventType::TaggedSymbol + ) + PAYMENT_DELETED = + T.let( + :"payment.deleted", + FinchAPI::PaymentEvent::EventType::TaggedSymbol + ) - sig { override.returns(T::Array[FinchAPI::Models::PaymentEvent::EventType::TaggedSymbol]) } - def self.values; end + sig do + override.returns( + T::Array[FinchAPI::PaymentEvent::EventType::TaggedSymbol] + ) + end + def self.values + end end end end diff --git a/rbi/finch_api/models/payroll/pay_group_list_params.rbi b/rbi/finch_api/models/payroll/pay_group_list_params.rbi index c734048a..7beea8af 100644 --- a/rbi/finch_api/models/payroll/pay_group_list_params.rbi +++ b/rbi/finch_api/models/payroll/pay_group_list_params.rbi @@ -7,6 +7,9 @@ module FinchAPI extend FinchAPI::Internal::Type::RequestParameters::Converter include FinchAPI::Internal::Type::RequestParameters + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + sig { returns(T.nilable(String)) } attr_reader :individual_id @@ -23,23 +26,27 @@ module FinchAPI params( individual_id: String, pay_frequencies: T::Array[String], - request_options: T.any(FinchAPI::RequestOptions, FinchAPI::Internal::AnyHash) - ) - .returns(T.attached_class) + request_options: FinchAPI::RequestOptions::OrHash + ).returns(T.attached_class) + end + def self.new( + individual_id: nil, + pay_frequencies: nil, + request_options: {} + ) end - def self.new(individual_id: nil, pay_frequencies: nil, request_options: {}); end sig do - override - .returns( - { - individual_id: String, - pay_frequencies: T::Array[String], - request_options: FinchAPI::RequestOptions - } - ) + override.returns( + { + individual_id: String, + pay_frequencies: T::Array[String], + request_options: FinchAPI::RequestOptions + } + ) + end + def to_hash end - def to_hash; end end end end diff --git a/rbi/finch_api/models/payroll/pay_group_list_response.rbi b/rbi/finch_api/models/payroll/pay_group_list_response.rbi index 1f30b8ec..b83a5581 100644 --- a/rbi/finch_api/models/payroll/pay_group_list_response.rbi +++ b/rbi/finch_api/models/payroll/pay_group_list_response.rbi @@ -4,6 +4,9 @@ module FinchAPI module Models module Payroll class PayGroupListResponse < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + # Finch id (uuidv4) for the pay group sig { returns(T.nilable(String)) } attr_reader :id @@ -19,12 +22,24 @@ module FinchAPI attr_writer :name # List of pay frequencies associated with this pay group - sig { returns(T.nilable(T::Array[FinchAPI::Models::Payroll::PayGroupListResponse::PayFrequency::TaggedSymbol])) } + sig do + returns( + T.nilable( + T::Array[ + FinchAPI::Models::Payroll::PayGroupListResponse::PayFrequency::TaggedSymbol + ] + ) + ) + end attr_reader :pay_frequencies sig do - params(pay_frequencies: T::Array[FinchAPI::Models::Payroll::PayGroupListResponse::PayFrequency::OrSymbol]) - .void + params( + pay_frequencies: + T::Array[ + FinchAPI::Models::Payroll::PayGroupListResponse::PayFrequency::OrSymbol + ] + ).void end attr_writer :pay_frequencies @@ -32,9 +47,11 @@ module FinchAPI params( id: String, name: String, - pay_frequencies: T::Array[FinchAPI::Models::Payroll::PayGroupListResponse::PayFrequency::OrSymbol] - ) - .returns(T.attached_class) + pay_frequencies: + T::Array[ + FinchAPI::Models::Payroll::PayGroupListResponse::PayFrequency::OrSymbol + ] + ).returns(T.attached_class) end def self.new( # Finch id (uuidv4) for the pay group @@ -43,42 +60,91 @@ module FinchAPI name: nil, # List of pay frequencies associated with this pay group pay_frequencies: nil - ); end + ) + end + sig do - override - .returns( - { - id: String, - name: String, - pay_frequencies: T::Array[FinchAPI::Models::Payroll::PayGroupListResponse::PayFrequency::TaggedSymbol] - } - ) + override.returns( + { + id: String, + name: String, + pay_frequencies: + T::Array[ + FinchAPI::Models::Payroll::PayGroupListResponse::PayFrequency::TaggedSymbol + ] + } + ) + end + def to_hash end - def to_hash; end module PayFrequency extend FinchAPI::Internal::Type::Enum TaggedSymbol = - T.type_alias { T.all(Symbol, FinchAPI::Models::Payroll::PayGroupListResponse::PayFrequency) } + T.type_alias do + T.all( + Symbol, + FinchAPI::Models::Payroll::PayGroupListResponse::PayFrequency + ) + end OrSymbol = T.type_alias { T.any(Symbol, String) } - ANNUALLY = T.let(:annually, FinchAPI::Models::Payroll::PayGroupListResponse::PayFrequency::TaggedSymbol) + ANNUALLY = + T.let( + :annually, + FinchAPI::Models::Payroll::PayGroupListResponse::PayFrequency::TaggedSymbol + ) SEMI_ANNUALLY = - T.let(:semi_annually, FinchAPI::Models::Payroll::PayGroupListResponse::PayFrequency::TaggedSymbol) + 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) + 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) + 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) + 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 + ) - sig { override.returns(T::Array[FinchAPI::Models::Payroll::PayGroupListResponse::PayFrequency::TaggedSymbol]) } - def self.values; end + sig do + override.returns( + T::Array[ + FinchAPI::Models::Payroll::PayGroupListResponse::PayFrequency::TaggedSymbol + ] + ) + end + def self.values + end end end end diff --git a/rbi/finch_api/models/payroll/pay_group_retrieve_params.rbi b/rbi/finch_api/models/payroll/pay_group_retrieve_params.rbi index dbee8c11..5f4610ef 100644 --- a/rbi/finch_api/models/payroll/pay_group_retrieve_params.rbi +++ b/rbi/finch_api/models/payroll/pay_group_retrieve_params.rbi @@ -7,14 +7,20 @@ module FinchAPI extend FinchAPI::Internal::Type::RequestParameters::Converter include FinchAPI::Internal::Type::RequestParameters + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + sig do - params(request_options: T.any(FinchAPI::RequestOptions, FinchAPI::Internal::AnyHash)) - .returns(T.attached_class) + params(request_options: FinchAPI::RequestOptions::OrHash).returns( + T.attached_class + ) + end + def self.new(request_options: {}) end - def self.new(request_options: {}); end - sig { override.returns({request_options: FinchAPI::RequestOptions}) } - def to_hash; end + sig { override.returns({ request_options: FinchAPI::RequestOptions }) } + def to_hash + end end end end diff --git a/rbi/finch_api/models/payroll/pay_group_retrieve_response.rbi b/rbi/finch_api/models/payroll/pay_group_retrieve_response.rbi index 593960e2..5d980b81 100644 --- a/rbi/finch_api/models/payroll/pay_group_retrieve_response.rbi +++ b/rbi/finch_api/models/payroll/pay_group_retrieve_response.rbi @@ -4,6 +4,9 @@ module FinchAPI module Models module Payroll class PayGroupRetrieveResponse < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + # Finch id (uuidv4) for the pay group sig { returns(String) } attr_accessor :id @@ -16,7 +19,13 @@ module FinchAPI attr_accessor :name # List of pay frequencies associated with this pay group - sig { returns(T::Array[FinchAPI::Models::Payroll::PayGroupRetrieveResponse::PayFrequency::TaggedSymbol]) } + sig do + returns( + T::Array[ + FinchAPI::Models::Payroll::PayGroupRetrieveResponse::PayFrequency::TaggedSymbol + ] + ) + end attr_accessor :pay_frequencies sig do @@ -24,9 +33,11 @@ module FinchAPI id: String, individual_ids: T::Array[String], name: String, - pay_frequencies: T::Array[FinchAPI::Models::Payroll::PayGroupRetrieveResponse::PayFrequency::OrSymbol] - ) - .returns(T.attached_class) + pay_frequencies: + T::Array[ + FinchAPI::Models::Payroll::PayGroupRetrieveResponse::PayFrequency::OrSymbol + ] + ).returns(T.attached_class) end def self.new( # Finch id (uuidv4) for the pay group @@ -36,47 +47,92 @@ module FinchAPI name:, # List of pay frequencies associated with this pay group pay_frequencies: - ); end + ) + end + sig do - override - .returns( - { - id: String, - individual_ids: T::Array[String], - name: String, - pay_frequencies: T::Array[FinchAPI::Models::Payroll::PayGroupRetrieveResponse::PayFrequency::TaggedSymbol] - } - ) + override.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 - def to_hash; end module PayFrequency extend FinchAPI::Internal::Type::Enum TaggedSymbol = - T.type_alias { T.all(Symbol, FinchAPI::Models::Payroll::PayGroupRetrieveResponse::PayFrequency) } + T.type_alias do + T.all( + Symbol, + FinchAPI::Models::Payroll::PayGroupRetrieveResponse::PayFrequency + ) + end OrSymbol = T.type_alias { T.any(Symbol, String) } ANNUALLY = - T.let(:annually, FinchAPI::Models::Payroll::PayGroupRetrieveResponse::PayFrequency::TaggedSymbol) + T.let( + :annually, + FinchAPI::Models::Payroll::PayGroupRetrieveResponse::PayFrequency::TaggedSymbol + ) SEMI_ANNUALLY = - T.let(:semi_annually, FinchAPI::Models::Payroll::PayGroupRetrieveResponse::PayFrequency::TaggedSymbol) + T.let( + :semi_annually, + FinchAPI::Models::Payroll::PayGroupRetrieveResponse::PayFrequency::TaggedSymbol + ) QUARTERLY = - T.let(:quarterly, FinchAPI::Models::Payroll::PayGroupRetrieveResponse::PayFrequency::TaggedSymbol) + T.let( + :quarterly, + FinchAPI::Models::Payroll::PayGroupRetrieveResponse::PayFrequency::TaggedSymbol + ) MONTHLY = - T.let(:monthly, FinchAPI::Models::Payroll::PayGroupRetrieveResponse::PayFrequency::TaggedSymbol) + T.let( + :monthly, + FinchAPI::Models::Payroll::PayGroupRetrieveResponse::PayFrequency::TaggedSymbol + ) SEMI_MONTHLY = - T.let(:semi_monthly, FinchAPI::Models::Payroll::PayGroupRetrieveResponse::PayFrequency::TaggedSymbol) + 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) + 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 + ) sig do - override.returns(T::Array[FinchAPI::Models::Payroll::PayGroupRetrieveResponse::PayFrequency::TaggedSymbol]) + override.returns( + T::Array[ + FinchAPI::Models::Payroll::PayGroupRetrieveResponse::PayFrequency::TaggedSymbol + ] + ) + end + def self.values end - def self.values; end end end end diff --git a/rbi/finch_api/models/provider.rbi b/rbi/finch_api/models/provider.rbi index 85337c58..51e08ee7 100644 --- a/rbi/finch_api/models/provider.rbi +++ b/rbi/finch_api/models/provider.rbi @@ -3,6 +3,8 @@ module FinchAPI module Models class Provider < FinchAPI::Internal::Type::BaseModel + OrHash = T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + # The id of the payroll provider used in Connect. sig { returns(T.nilable(String)) } attr_reader :id @@ -11,14 +13,16 @@ module FinchAPI attr_writer :id # The list of authentication methods supported by the provider. - sig { returns(T.nilable(T::Array[FinchAPI::Models::Provider::AuthenticationMethod])) } + sig do + returns(T.nilable(T::Array[FinchAPI::Provider::AuthenticationMethod])) + end attr_reader :authentication_methods sig do params( - authentication_methods: T::Array[T.any(FinchAPI::Models::Provider::AuthenticationMethod, FinchAPI::Internal::AnyHash)] - ) - .void + authentication_methods: + T::Array[FinchAPI::Provider::AuthenticationMethod::OrHash] + ).void end attr_writer :authentication_methods @@ -83,7 +87,8 @@ module FinchAPI sig do params( id: String, - authentication_methods: T::Array[T.any(FinchAPI::Models::Provider::AuthenticationMethod, FinchAPI::Internal::AnyHash)], + authentication_methods: + T::Array[FinchAPI::Provider::AuthenticationMethod::OrHash], beta: T::Boolean, display_name: String, icon: String, @@ -92,8 +97,7 @@ module FinchAPI mfa_required: T::Boolean, primary_color: String, products: T::Array[String] - ) - .returns(T.attached_class) + ).returns(T.attached_class) end def self.new( # The id of the payroll provider used in Connect. @@ -118,70 +122,90 @@ module FinchAPI primary_color: nil, # The list of Finch products supported on this payroll provider. products: nil - ); end + ) + end + sig do - override - .returns( - { - id: String, - authentication_methods: T::Array[FinchAPI::Models::Provider::AuthenticationMethod], - beta: T::Boolean, - display_name: String, - icon: String, - logo: String, - manual: T::Boolean, - mfa_required: T::Boolean, - primary_color: String, - products: T::Array[String] - } - ) + override.returns( + { + id: String, + authentication_methods: + T::Array[FinchAPI::Provider::AuthenticationMethod], + beta: T::Boolean, + display_name: String, + icon: String, + logo: String, + manual: T::Boolean, + mfa_required: T::Boolean, + primary_color: String, + products: T::Array[String] + } + ) + end + def to_hash end - def to_hash; end class AuthenticationMethod < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + # 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)) } + sig { returns(T.nilable(FinchAPI::HRIS::BenefitsSupport)) } attr_reader :benefits_support sig do params( - benefits_support: T.nilable(T.any(FinchAPI::Models::HRIS::BenefitsSupport, FinchAPI::Internal::AnyHash)) - ) - .void + benefits_support: T.nilable(FinchAPI::HRIS::BenefitsSupport::OrHash) + ).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)) } + sig do + returns( + T.nilable(FinchAPI::Provider::AuthenticationMethod::SupportedFields) + ) + end attr_reader :supported_fields sig do params( - supported_fields: T.nilable( - T.any(FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields, FinchAPI::Internal::AnyHash) - ) - ) - .void + supported_fields: + T.nilable( + FinchAPI::Provider::AuthenticationMethod::SupportedFields::OrHash + ) + ).void end attr_writer :supported_fields # The type of authentication method. - sig { returns(T.nilable(FinchAPI::Models::Provider::AuthenticationMethod::Type::TaggedSymbol)) } + sig do + returns( + T.nilable( + FinchAPI::Provider::AuthenticationMethod::Type::TaggedSymbol + ) + ) + end attr_reader :type - sig { params(type: FinchAPI::Models::Provider::AuthenticationMethod::Type::OrSymbol).void } + sig do + params( + type: FinchAPI::Provider::AuthenticationMethod::Type::OrSymbol + ).void + end attr_writer :type sig do params( - benefits_support: T.nilable(T.any(FinchAPI::Models::HRIS::BenefitsSupport, FinchAPI::Internal::AnyHash)), - supported_fields: T.nilable( - T.any(FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields, FinchAPI::Internal::AnyHash) - ), - type: FinchAPI::Models::Provider::AuthenticationMethod::Type::OrSymbol - ) - .returns(T.attached_class) + benefits_support: + T.nilable(FinchAPI::HRIS::BenefitsSupport::OrHash), + supported_fields: + T.nilable( + FinchAPI::Provider::AuthenticationMethod::SupportedFields::OrHash + ), + type: FinchAPI::Provider::AuthenticationMethod::Type::OrSymbol + ).returns(T.attached_class) end def self.new( # Each benefit type and their supported features. If the benefit type is not @@ -191,151 +215,165 @@ module FinchAPI supported_fields: nil, # The type of authentication method. type: nil - ); end + ) + end + sig do - override - .returns( - { - benefits_support: T.nilable(FinchAPI::Models::HRIS::BenefitsSupport), - supported_fields: T.nilable(FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields), - type: FinchAPI::Models::Provider::AuthenticationMethod::Type::TaggedSymbol - } - ) + override.returns( + { + benefits_support: T.nilable(FinchAPI::HRIS::BenefitsSupport), + supported_fields: + T.nilable( + FinchAPI::Provider::AuthenticationMethod::SupportedFields + ), + type: FinchAPI::Provider::AuthenticationMethod::Type::TaggedSymbol + } + ) + end + def to_hash end - def to_hash; end class SupportedFields < FinchAPI::Internal::Type::BaseModel - sig { returns(T.nilable(FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company)) } - attr_reader :company + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } sig do - params( - company: T.any( - FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company, - FinchAPI::Internal::AnyHash + returns( + T.nilable( + FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company ) ) - .void + end + attr_reader :company + + sig do + params( + company: + FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company::OrHash + ).void end attr_writer :company - sig { returns(T.nilable(FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Directory)) } + sig do + returns( + T.nilable( + FinchAPI::Provider::AuthenticationMethod::SupportedFields::Directory + ) + ) + end attr_reader :directory sig do params( - directory: T.any( - FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Directory, - FinchAPI::Internal::AnyHash - ) - ) - .void + directory: + FinchAPI::Provider::AuthenticationMethod::SupportedFields::Directory::OrHash + ).void end attr_writer :directory - sig { returns(T.nilable(FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment)) } + sig do + returns( + T.nilable( + FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment + ) + ) + end attr_reader :employment sig do params( - employment: T.any( - FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment, - FinchAPI::Internal::AnyHash - ) - ) - .void + employment: + FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment::OrHash + ).void end attr_writer :employment - sig { returns(T.nilable(FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Individual)) } + sig do + returns( + T.nilable( + FinchAPI::Provider::AuthenticationMethod::SupportedFields::Individual + ) + ) + end attr_reader :individual sig do params( - individual: T.any( - FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Individual, - FinchAPI::Internal::AnyHash - ) - ) - .void + individual: + FinchAPI::Provider::AuthenticationMethod::SupportedFields::Individual::OrHash + ).void end attr_writer :individual - sig { returns(T.nilable(FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayGroup)) } + sig do + returns( + T.nilable( + FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayGroup + ) + ) + end attr_reader :pay_group sig do params( - pay_group: T.any( - FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayGroup, - FinchAPI::Internal::AnyHash - ) - ) - .void + pay_group: + FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayGroup::OrHash + ).void end attr_writer :pay_group - sig { returns(T.nilable(FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement)) } + sig do + returns( + T.nilable( + FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement + ) + ) + end attr_reader :pay_statement sig do params( - pay_statement: T.any( - FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement, - FinchAPI::Internal::AnyHash - ) - ) - .void + pay_statement: + FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::OrHash + ).void end attr_writer :pay_statement - sig { returns(T.nilable(FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Payment)) } + sig do + returns( + T.nilable( + FinchAPI::Provider::AuthenticationMethod::SupportedFields::Payment + ) + ) + end attr_reader :payment sig do params( - payment: T.any( - FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Payment, - FinchAPI::Internal::AnyHash - ) - ) - .void + payment: + FinchAPI::Provider::AuthenticationMethod::SupportedFields::Payment::OrHash + ).void end attr_writer :payment # The supported data fields returned by our HR and payroll endpoints sig do params( - company: T.any( - FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company, - FinchAPI::Internal::AnyHash - ), - directory: T.any( - FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Directory, - FinchAPI::Internal::AnyHash - ), - employment: T.any( - FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment, - FinchAPI::Internal::AnyHash - ), - individual: T.any( - FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Individual, - FinchAPI::Internal::AnyHash - ), - pay_group: T.any( - FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayGroup, - FinchAPI::Internal::AnyHash - ), - pay_statement: T.any( - FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement, - FinchAPI::Internal::AnyHash - ), - payment: T.any( - FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Payment, - FinchAPI::Internal::AnyHash - ) - ) - .returns(T.attached_class) + company: + FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company::OrHash, + directory: + FinchAPI::Provider::AuthenticationMethod::SupportedFields::Directory::OrHash, + employment: + FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment::OrHash, + individual: + FinchAPI::Provider::AuthenticationMethod::SupportedFields::Individual::OrHash, + pay_group: + FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayGroup::OrHash, + pay_statement: + FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::OrHash, + payment: + FinchAPI::Provider::AuthenticationMethod::SupportedFields::Payment::OrHash + ).returns(T.attached_class) end def self.new( company: nil, @@ -345,59 +383,73 @@ module FinchAPI pay_group: nil, pay_statement: nil, payment: nil - ); end + ) + end + sig do - override - .returns( - { - 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 - } - ) + override.returns( + { + company: + FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company, + directory: + FinchAPI::Provider::AuthenticationMethod::SupportedFields::Directory, + employment: + FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment, + individual: + FinchAPI::Provider::AuthenticationMethod::SupportedFields::Individual, + pay_group: + FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayGroup, + pay_statement: + FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement, + payment: + FinchAPI::Provider::AuthenticationMethod::SupportedFields::Payment + } + ) + end + def to_hash end - def to_hash; end class Company < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + sig { returns(T.nilable(T::Boolean)) } attr_reader :id sig { params(id: T::Boolean).void } attr_writer :id - sig { returns(T.nilable(FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Accounts)) } + sig do + returns( + T.nilable( + FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company::Accounts + ) + ) + end attr_reader :accounts sig do params( - accounts: T.any( - FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Accounts, - FinchAPI::Internal::AnyHash - ) - ) - .void + accounts: + FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company::Accounts::OrHash + ).void end attr_writer :accounts sig do returns( - T.nilable(FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Departments) + T.nilable( + FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company::Departments + ) ) end attr_reader :departments sig do params( - departments: T.any( - FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Departments, - FinchAPI::Internal::AnyHash - ) - ) - .void + departments: + FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company::Departments::OrHash + ).void end attr_writer :departments @@ -407,17 +459,20 @@ module FinchAPI sig { params(ein: T::Boolean).void } attr_writer :ein - sig { returns(T.nilable(FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Entity)) } + sig do + returns( + T.nilable( + FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company::Entity + ) + ) + end attr_reader :entity sig do params( - entity: T.any( - FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Entity, - FinchAPI::Internal::AnyHash - ) - ) - .void + entity: + FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company::Entity::OrHash + ).void end attr_writer :entity @@ -427,17 +482,20 @@ module FinchAPI sig { params(legal_name: T::Boolean).void } attr_writer :legal_name - sig { returns(T.nilable(FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Locations)) } + sig do + returns( + T.nilable( + FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company::Locations + ) + ) + end attr_reader :locations sig do params( - locations: T.any( - FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Locations, - FinchAPI::Internal::AnyHash - ) - ) - .void + locations: + FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company::Locations::OrHash + ).void end attr_writer :locations @@ -456,28 +514,19 @@ module FinchAPI sig do params( id: T::Boolean, - accounts: T.any( - FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Accounts, - FinchAPI::Internal::AnyHash - ), - departments: T.any( - FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Departments, - FinchAPI::Internal::AnyHash - ), + accounts: + FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company::Accounts::OrHash, + departments: + FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company::Departments::OrHash, ein: T::Boolean, - entity: T.any( - FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Entity, - FinchAPI::Internal::AnyHash - ), + entity: + FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company::Entity::OrHash, legal_name: T::Boolean, - locations: T.any( - FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Locations, - FinchAPI::Internal::AnyHash - ), + locations: + FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company::Locations::OrHash, primary_email: T::Boolean, primary_phone_number: T::Boolean - ) - .returns(T.attached_class) + ).returns(T.attached_class) end def self.new( id: nil, @@ -489,26 +538,35 @@ module FinchAPI locations: nil, primary_email: nil, primary_phone_number: nil - ); end + ) + end + sig do - override - .returns( - { - id: T::Boolean, - accounts: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Accounts, - departments: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Departments, - ein: T::Boolean, - entity: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Entity, - legal_name: T::Boolean, - locations: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Locations, - primary_email: T::Boolean, - primary_phone_number: T::Boolean - } - ) + override.returns( + { + id: T::Boolean, + accounts: + FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company::Accounts, + departments: + FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company::Departments, + ein: T::Boolean, + entity: + FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company::Entity, + legal_name: T::Boolean, + locations: + FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company::Locations, + primary_email: T::Boolean, + primary_phone_number: T::Boolean + } + ) + end + def to_hash end - def to_hash; end class Accounts < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + sig { returns(T.nilable(T::Boolean)) } attr_reader :account_name @@ -546,8 +604,7 @@ module FinchAPI account_type: T::Boolean, institution_name: T::Boolean, routing_number: T::Boolean - ) - .returns(T.attached_class) + ).returns(T.attached_class) end def self.new( account_name: nil, @@ -559,21 +616,24 @@ module FinchAPI end sig do - override - .returns( - { - account_name: T::Boolean, - account_number: T::Boolean, - account_type: T::Boolean, - institution_name: T::Boolean, - routing_number: T::Boolean - } - ) + override.returns( + { + account_name: T::Boolean, + account_number: T::Boolean, + account_type: T::Boolean, + institution_name: T::Boolean, + routing_number: T::Boolean + } + ) + end + def to_hash end - def to_hash; end end class Departments < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + sig { returns(T.nilable(T::Boolean)) } attr_reader :name @@ -582,46 +642,49 @@ module FinchAPI sig do returns( - T.nilable(FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Departments::Parent) + T.nilable( + FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company::Departments::Parent + ) ) end attr_reader :parent sig do params( - parent: T.any( - FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Departments::Parent, - FinchAPI::Internal::AnyHash - ) - ) - .void + parent: + FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company::Departments::Parent::OrHash + ).void end attr_writer :parent sig do params( name: T::Boolean, - parent: T.any( - FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Departments::Parent, - FinchAPI::Internal::AnyHash - ) - ) - .returns(T.attached_class) + parent: + FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company::Departments::Parent::OrHash + ).returns(T.attached_class) + end + def self.new(name: nil, parent: nil) end - def self.new(name: nil, parent: nil); end sig do - override - .returns( - { - name: T::Boolean, - parent: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Departments::Parent - } - ) + override.returns( + { + name: T::Boolean, + parent: + FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company::Departments::Parent + } + ) + end + def to_hash end - def to_hash; end class Parent < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any(T.self_type, FinchAPI::Internal::AnyHash) + end + sig { returns(T.nilable(T::Boolean)) } attr_reader :name @@ -629,14 +692,19 @@ module FinchAPI attr_writer :name sig { params(name: T::Boolean).returns(T.attached_class) } - def self.new(name: nil); end + def self.new(name: nil) + end - sig { override.returns({name: T::Boolean}) } - def to_hash; end + sig { override.returns({ name: T::Boolean }) } + def to_hash + end end end class Entity < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + sig { returns(T.nilable(T::Boolean)) } attr_reader :subtype @@ -649,14 +717,25 @@ module FinchAPI 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); end + sig do + params(subtype: T::Boolean, type: T::Boolean).returns( + T.attached_class + ) + end + def self.new(subtype: nil, type: nil) + end - sig { override.returns({subtype: T::Boolean, type: T::Boolean}) } - def to_hash; end + sig do + override.returns({ subtype: T::Boolean, type: T::Boolean }) + end + def to_hash + end end class Locations < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + sig { returns(T.nilable(T::Boolean)) } attr_reader :city @@ -701,88 +780,101 @@ module FinchAPI line2: T::Boolean, postal_code: T::Boolean, state: T::Boolean - ) - .returns(T.attached_class) + ).returns(T.attached_class) + end + def self.new( + city: nil, + country: nil, + line1: nil, + line2: nil, + postal_code: nil, + state: nil + ) end - def self.new(city: nil, country: nil, line1: nil, line2: nil, postal_code: nil, state: nil); end sig do - override - .returns( - { - city: T::Boolean, - country: T::Boolean, - line1: T::Boolean, - line2: T::Boolean, - postal_code: T::Boolean, - state: T::Boolean - } - ) + override.returns( + { + city: T::Boolean, + country: T::Boolean, + line1: T::Boolean, + line2: T::Boolean, + postal_code: T::Boolean, + state: T::Boolean + } + ) + end + def to_hash end - def to_hash; end end end class Directory < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + sig do returns( - T.nilable(FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Directory::Individuals) + T.nilable( + FinchAPI::Provider::AuthenticationMethod::SupportedFields::Directory::Individuals + ) ) end attr_reader :individuals sig do params( - individuals: T.any( - FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Directory::Individuals, - FinchAPI::Internal::AnyHash - ) - ) - .void + individuals: + FinchAPI::Provider::AuthenticationMethod::SupportedFields::Directory::Individuals::OrHash + ).void end attr_writer :individuals - sig { returns(T.nilable(FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Directory::Paging)) } + sig do + returns( + T.nilable( + FinchAPI::Provider::AuthenticationMethod::SupportedFields::Directory::Paging + ) + ) + end attr_reader :paging sig do params( - paging: T.any( - FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Directory::Paging, - FinchAPI::Internal::AnyHash - ) - ) - .void + paging: + FinchAPI::Provider::AuthenticationMethod::SupportedFields::Directory::Paging::OrHash + ).void end attr_writer :paging sig do params( - individuals: T.any( - FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Directory::Individuals, - FinchAPI::Internal::AnyHash - ), - paging: T.any( - FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Directory::Paging, - FinchAPI::Internal::AnyHash - ) - ) - .returns(T.attached_class) + individuals: + FinchAPI::Provider::AuthenticationMethod::SupportedFields::Directory::Individuals::OrHash, + paging: + FinchAPI::Provider::AuthenticationMethod::SupportedFields::Directory::Paging::OrHash + ).returns(T.attached_class) + end + def self.new(individuals: nil, paging: nil) end - def self.new(individuals: nil, paging: nil); end sig do - override - .returns( - { - individuals: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Directory::Individuals, - paging: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Directory::Paging - } - ) + override.returns( + { + individuals: + FinchAPI::Provider::AuthenticationMethod::SupportedFields::Directory::Individuals, + paging: + FinchAPI::Provider::AuthenticationMethod::SupportedFields::Directory::Paging + } + ) + end + def to_hash end - def to_hash; end class Individuals < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + sig { returns(T.nilable(T::Boolean)) } attr_reader :id @@ -816,7 +908,7 @@ module FinchAPI sig do returns( T.nilable( - FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Directory::Individuals::Manager + FinchAPI::Provider::AuthenticationMethod::SupportedFields::Directory::Individuals::Manager ) ) end @@ -824,12 +916,9 @@ module FinchAPI sig do params( - manager: T.any( - FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Directory::Individuals::Manager, - FinchAPI::Internal::AnyHash - ) - ) - .void + manager: + FinchAPI::Provider::AuthenticationMethod::SupportedFields::Directory::Individuals::Manager::OrHash + ).void end attr_writer :manager @@ -846,13 +935,10 @@ module FinchAPI first_name: T::Boolean, is_active: T::Boolean, last_name: T::Boolean, - manager: T.any( - FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Directory::Individuals::Manager, - FinchAPI::Internal::AnyHash - ), + manager: + FinchAPI::Provider::AuthenticationMethod::SupportedFields::Directory::Individuals::Manager::OrHash, middle_name: T::Boolean - ) - .returns(T.attached_class) + ).returns(T.attached_class) end def self.new( id: nil, @@ -866,22 +952,28 @@ module FinchAPI end sig do - override - .returns( - { - id: T::Boolean, - department: T::Boolean, - first_name: T::Boolean, - is_active: T::Boolean, - last_name: T::Boolean, - manager: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Directory::Individuals::Manager, - middle_name: T::Boolean - } - ) + override.returns( + { + id: T::Boolean, + department: T::Boolean, + first_name: T::Boolean, + is_active: T::Boolean, + last_name: T::Boolean, + manager: + FinchAPI::Provider::AuthenticationMethod::SupportedFields::Directory::Individuals::Manager, + middle_name: T::Boolean + } + ) + end + def to_hash end - def to_hash; end class Manager < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any(T.self_type, FinchAPI::Internal::AnyHash) + end + sig { returns(T.nilable(T::Boolean)) } attr_reader :id @@ -889,14 +981,19 @@ module FinchAPI attr_writer :id sig { params(id: T::Boolean).returns(T.attached_class) } - def self.new(id: nil); end + def self.new(id: nil) + end - sig { override.returns({id: T::Boolean}) } - def to_hash; end + sig { override.returns({ id: T::Boolean }) } + def to_hash + end end end class Paging < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + sig { returns(T.nilable(T::Boolean)) } attr_reader :count @@ -909,15 +1006,26 @@ module FinchAPI 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); end + sig do + params(count: T::Boolean, offset: T::Boolean).returns( + T.attached_class + ) + end + def self.new(count: nil, offset: nil) + end - sig { override.returns({count: T::Boolean, offset: T::Boolean}) } - def to_hash; end + sig do + override.returns({ count: T::Boolean, offset: T::Boolean }) + end + def to_hash + end end end class Employment < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + sig { returns(T.nilable(T::Boolean)) } attr_reader :id @@ -938,37 +1046,35 @@ module FinchAPI sig do returns( - T.nilable(FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::Department) + T.nilable( + FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment::Department + ) ) end attr_reader :department sig do params( - department: T.any( - FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::Department, - FinchAPI::Internal::AnyHash - ) - ) - .void + department: + FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment::Department::OrHash + ).void end attr_writer :department sig do returns( - T.nilable(FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::Employment) + T.nilable( + FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment::Employment + ) ) end attr_reader :employment sig do params( - employment: T.any( - FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::Employment, - FinchAPI::Internal::AnyHash - ) - ) - .void + employment: + FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment::Employment::OrHash + ).void end attr_writer :employment @@ -990,17 +1096,20 @@ module FinchAPI sig { params(first_name: T::Boolean).void } attr_writer :first_name - sig { returns(T.nilable(FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::Income)) } + sig do + returns( + T.nilable( + FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment::Income + ) + ) + end attr_reader :income sig do params( - income: T.any( - FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::Income, - FinchAPI::Internal::AnyHash - ) - ) - .void + income: + FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment::Income::OrHash + ).void end attr_writer :income @@ -1024,33 +1133,35 @@ module FinchAPI sig do returns( - T.nilable(FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::Location) + T.nilable( + FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment::Location + ) ) end attr_reader :location sig do params( - location: T.any( - FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::Location, - FinchAPI::Internal::AnyHash - ) - ) - .void + location: + FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment::Location::OrHash + ).void end attr_writer :location - sig { returns(T.nilable(FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::Manager)) } + sig do + returns( + T.nilable( + FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment::Manager + ) + ) + end attr_reader :manager sig do params( - manager: T.any( - FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::Manager, - FinchAPI::Internal::AnyHash - ) - ) - .void + manager: + FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment::Manager::OrHash + ).void end attr_writer :manager @@ -1077,37 +1188,26 @@ module FinchAPI id: T::Boolean, class_code: T::Boolean, custom_fields: T::Boolean, - department: T.any( - FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::Department, - FinchAPI::Internal::AnyHash - ), - employment: T.any( - FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::Employment, - FinchAPI::Internal::AnyHash - ), + department: + FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment::Department::OrHash, + employment: + FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment::Employment::OrHash, employment_status: T::Boolean, end_date: T::Boolean, first_name: T::Boolean, - income: T.any( - FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::Income, - FinchAPI::Internal::AnyHash - ), + income: + FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment::Income::OrHash, income_history: T::Boolean, is_active: T::Boolean, last_name: T::Boolean, - location: T.any( - FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::Location, - FinchAPI::Internal::AnyHash - ), - manager: T.any( - FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::Manager, - FinchAPI::Internal::AnyHash - ), + location: + FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment::Location::OrHash, + manager: + FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment::Manager::OrHash, middle_name: T::Boolean, start_date: T::Boolean, title: T::Boolean - ) - .returns(T.attached_class) + ).returns(T.attached_class) end def self.new( id: nil, @@ -1127,34 +1227,44 @@ module FinchAPI middle_name: nil, start_date: nil, title: nil - ); end + ) + end + sig do - override - .returns( - { - 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, - employment_status: T::Boolean, - end_date: T::Boolean, - first_name: T::Boolean, - income: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::Income, - 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, - middle_name: T::Boolean, - start_date: T::Boolean, - title: T::Boolean - } - ) + override.returns( + { + id: T::Boolean, + class_code: T::Boolean, + custom_fields: T::Boolean, + department: + FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment::Department, + employment: + FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment::Employment, + employment_status: T::Boolean, + end_date: T::Boolean, + first_name: T::Boolean, + income: + FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment::Income, + income_history: T::Boolean, + is_active: T::Boolean, + last_name: T::Boolean, + location: + FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment::Location, + manager: + FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment::Manager, + middle_name: T::Boolean, + start_date: T::Boolean, + title: T::Boolean + } + ) + end + def to_hash end - def to_hash; end class Department < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + sig { returns(T.nilable(T::Boolean)) } attr_reader :name @@ -1162,13 +1272,18 @@ module FinchAPI attr_writer :name sig { params(name: T::Boolean).returns(T.attached_class) } - def self.new(name: nil); end + def self.new(name: nil) + end - sig { override.returns({name: T::Boolean}) } - def to_hash; end + sig { override.returns({ name: T::Boolean }) } + def to_hash + end end class Employment < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + sig { returns(T.nilable(T::Boolean)) } attr_reader :subtype @@ -1181,14 +1296,25 @@ module FinchAPI 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); end + sig do + params(subtype: T::Boolean, type: T::Boolean).returns( + T.attached_class + ) + end + def self.new(subtype: nil, type: nil) + end - sig { override.returns({subtype: T::Boolean, type: T::Boolean}) } - def to_hash; end + sig do + override.returns({ subtype: T::Boolean, type: T::Boolean }) + end + def to_hash + end end class Income < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + sig { returns(T.nilable(T::Boolean)) } attr_reader :amount @@ -1208,15 +1334,28 @@ module FinchAPI attr_writer :unit sig do - params(amount: T::Boolean, currency: T::Boolean, unit: T::Boolean).returns(T.attached_class) + 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 - def self.new(amount: nil, currency: nil, unit: nil); end - sig { override.returns({amount: T::Boolean, currency: T::Boolean, unit: T::Boolean}) } - def to_hash; end + sig do + override.returns( + { amount: T::Boolean, currency: T::Boolean, unit: T::Boolean } + ) + end + def to_hash + end end class Location < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + sig { returns(T.nilable(T::Boolean)) } attr_reader :city @@ -1261,28 +1400,38 @@ module FinchAPI line2: T::Boolean, postal_code: T::Boolean, state: T::Boolean - ) - .returns(T.attached_class) + ).returns(T.attached_class) + end + def self.new( + city: nil, + country: nil, + line1: nil, + line2: nil, + postal_code: nil, + state: nil + ) end - def self.new(city: nil, country: nil, line1: nil, line2: nil, postal_code: nil, state: nil); end sig do - override - .returns( - { - city: T::Boolean, - country: T::Boolean, - line1: T::Boolean, - line2: T::Boolean, - postal_code: T::Boolean, - state: T::Boolean - } - ) + override.returns( + { + city: T::Boolean, + country: T::Boolean, + line1: T::Boolean, + line2: T::Boolean, + postal_code: T::Boolean, + state: T::Boolean + } + ) + end + def to_hash end - def to_hash; end end class Manager < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + sig { returns(T.nilable(T::Boolean)) } attr_reader :id @@ -1290,14 +1439,19 @@ module FinchAPI attr_writer :id sig { params(id: T::Boolean).returns(T.attached_class) } - def self.new(id: nil); end + def self.new(id: nil) + end - sig { override.returns({id: T::Boolean}) } - def to_hash; end + sig { override.returns({ id: T::Boolean }) } + def to_hash + end end end class Individual < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + sig { returns(T.nilable(T::Boolean)) } attr_reader :id @@ -1310,17 +1464,20 @@ module FinchAPI sig { params(dob: T::Boolean).void } attr_writer :dob - sig { returns(T.nilable(FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Individual::Emails)) } + sig do + returns( + T.nilable( + FinchAPI::Provider::AuthenticationMethod::SupportedFields::Individual::Emails + ) + ) + end attr_reader :emails sig do params( - emails: T.any( - FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Individual::Emails, - FinchAPI::Internal::AnyHash - ) - ) - .void + emails: + FinchAPI::Provider::AuthenticationMethod::SupportedFields::Individual::Emails::OrHash + ).void end attr_writer :emails @@ -1362,19 +1519,18 @@ module FinchAPI sig do returns( - T.nilable(FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Individual::PhoneNumbers) + T.nilable( + FinchAPI::Provider::AuthenticationMethod::SupportedFields::Individual::PhoneNumbers + ) ) end attr_reader :phone_numbers sig do params( - phone_numbers: T.any( - FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Individual::PhoneNumbers, - FinchAPI::Internal::AnyHash - ) - ) - .void + phone_numbers: + FinchAPI::Provider::AuthenticationMethod::SupportedFields::Individual::PhoneNumbers::OrHash + ).void end attr_writer :phone_numbers @@ -1386,19 +1542,18 @@ module FinchAPI sig do returns( - T.nilable(FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Individual::Residence) + T.nilable( + FinchAPI::Provider::AuthenticationMethod::SupportedFields::Individual::Residence + ) ) end attr_reader :residence sig do params( - residence: T.any( - FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Individual::Residence, - FinchAPI::Internal::AnyHash - ) - ) - .void + residence: + FinchAPI::Provider::AuthenticationMethod::SupportedFields::Individual::Residence::OrHash + ).void end attr_writer :residence @@ -1412,28 +1567,21 @@ module FinchAPI params( id: T::Boolean, dob: T::Boolean, - emails: T.any( - FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Individual::Emails, - FinchAPI::Internal::AnyHash - ), + emails: + FinchAPI::Provider::AuthenticationMethod::SupportedFields::Individual::Emails::OrHash, encrypted_ssn: T::Boolean, ethnicity: T::Boolean, first_name: T::Boolean, gender: T::Boolean, last_name: T::Boolean, middle_name: T::Boolean, - phone_numbers: T.any( - FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Individual::PhoneNumbers, - FinchAPI::Internal::AnyHash - ), + phone_numbers: + FinchAPI::Provider::AuthenticationMethod::SupportedFields::Individual::PhoneNumbers::OrHash, preferred_name: T::Boolean, - residence: T.any( - FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Individual::Residence, - FinchAPI::Internal::AnyHash - ), + residence: + FinchAPI::Provider::AuthenticationMethod::SupportedFields::Individual::Residence::OrHash, ssn: T::Boolean - ) - .returns(T.attached_class) + ).returns(T.attached_class) end def self.new( id: nil, @@ -1449,30 +1597,38 @@ module FinchAPI preferred_name: nil, residence: nil, ssn: nil - ); end + ) + end + sig do - override - .returns( - { - id: T::Boolean, - dob: T::Boolean, - emails: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Individual::Emails, - 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, - preferred_name: T::Boolean, - residence: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Individual::Residence, - ssn: T::Boolean - } - ) + override.returns( + { + id: T::Boolean, + dob: T::Boolean, + emails: + FinchAPI::Provider::AuthenticationMethod::SupportedFields::Individual::Emails, + 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::Provider::AuthenticationMethod::SupportedFields::Individual::PhoneNumbers, + preferred_name: T::Boolean, + residence: + FinchAPI::Provider::AuthenticationMethod::SupportedFields::Individual::Residence, + ssn: T::Boolean + } + ) + end + def to_hash end - def to_hash; end class Emails < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + sig { returns(T.nilable(T::Boolean)) } attr_reader :data @@ -1485,14 +1641,23 @@ module FinchAPI 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); end + sig do + params(data: T::Boolean, type: T::Boolean).returns( + T.attached_class + ) + end + def self.new(data: nil, type: nil) + end - sig { override.returns({data: T::Boolean, type: T::Boolean}) } - def to_hash; end + sig { override.returns({ data: T::Boolean, type: T::Boolean }) } + def to_hash + end end class PhoneNumbers < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + sig { returns(T.nilable(T::Boolean)) } attr_reader :data @@ -1505,14 +1670,23 @@ module FinchAPI 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); end + sig do + params(data: T::Boolean, type: T::Boolean).returns( + T.attached_class + ) + end + def self.new(data: nil, type: nil) + end - sig { override.returns({data: T::Boolean, type: T::Boolean}) } - def to_hash; end + sig { override.returns({ data: T::Boolean, type: T::Boolean }) } + def to_hash + end end class Residence < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + sig { returns(T.nilable(T::Boolean)) } attr_reader :city @@ -1557,29 +1731,39 @@ module FinchAPI line2: T::Boolean, postal_code: T::Boolean, state: T::Boolean - ) - .returns(T.attached_class) + ).returns(T.attached_class) + end + def self.new( + city: nil, + country: nil, + line1: nil, + line2: nil, + postal_code: nil, + state: nil + ) end - def self.new(city: nil, country: nil, line1: nil, line2: nil, postal_code: nil, state: nil); end sig do - override - .returns( - { - city: T::Boolean, - country: T::Boolean, - line1: T::Boolean, - line2: T::Boolean, - postal_code: T::Boolean, - state: T::Boolean - } - ) + override.returns( + { + city: T::Boolean, + country: T::Boolean, + line1: T::Boolean, + line2: T::Boolean, + postal_code: T::Boolean, + state: T::Boolean + } + ) + end + def to_hash end - def to_hash; end end end class PayGroup < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + sig { returns(T.nilable(T::Boolean)) } attr_reader :id @@ -1610,105 +1794,125 @@ module FinchAPI individual_ids: T::Boolean, name: T::Boolean, pay_frequencies: T::Boolean - ) - .returns(T.attached_class) + ).returns(T.attached_class) + end + def self.new( + id: nil, + individual_ids: nil, + name: nil, + pay_frequencies: nil + ) end - def self.new(id: nil, individual_ids: nil, name: nil, pay_frequencies: nil); end sig do - override - .returns({ - id: T::Boolean, - individual_ids: T::Boolean, - name: T::Boolean, - pay_frequencies: T::Boolean - }) - end - def to_hash; end + override.returns( + { + id: T::Boolean, + individual_ids: T::Boolean, + name: T::Boolean, + pay_frequencies: T::Boolean + } + ) + end + def to_hash + end end class PayStatement < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + sig do returns( - T.nilable(FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::Paging) + T.nilable( + FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::Paging + ) ) end attr_reader :paging sig do params( - paging: T.any( - FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::Paging, - FinchAPI::Internal::AnyHash - ) - ) - .void + paging: + FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::Paging::OrHash + ).void end attr_writer :paging sig do returns( - T.nilable(FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements) + T.nilable( + FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements + ) ) end attr_reader :pay_statements sig do params( - pay_statements: T.any( - FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements, - FinchAPI::Internal::AnyHash - ) - ) - .void + pay_statements: + FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::OrHash + ).void end attr_writer :pay_statements sig do params( - paging: T.any( - FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::Paging, - FinchAPI::Internal::AnyHash - ), - pay_statements: T.any( - FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements, - FinchAPI::Internal::AnyHash - ) - ) - .returns(T.attached_class) + paging: + FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::Paging::OrHash, + pay_statements: + FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::OrHash + ).returns(T.attached_class) + end + def self.new(paging: nil, pay_statements: nil) end - def self.new(paging: nil, pay_statements: nil); end sig do - override - .returns( - { - paging: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::Paging, - pay_statements: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements - } - ) + override.returns( + { + paging: + FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::Paging, + pay_statements: + FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements + } + ) + end + def to_hash end - def to_hash; end class Paging < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + sig { returns(T::Boolean) } attr_accessor :count sig { returns(T::Boolean) } attr_accessor :offset - sig { params(count: T::Boolean, offset: T::Boolean).returns(T.attached_class) } - def self.new(count:, offset:); end + sig do + params(count: T::Boolean, offset: T::Boolean).returns( + T.attached_class + ) + end + def self.new(count:, offset:) + end - sig { override.returns({count: T::Boolean, offset: T::Boolean}) } - def to_hash; end + sig do + override.returns({ count: T::Boolean, offset: T::Boolean }) + end + def to_hash + end end class PayStatements < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + sig do returns( T.nilable( - FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Earnings + FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Earnings ) ) end @@ -1716,19 +1920,16 @@ module FinchAPI sig do params( - earnings: T.any( - FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Earnings, - FinchAPI::Internal::AnyHash - ) - ) - .void + earnings: + FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Earnings::OrHash + ).void end attr_writer :earnings sig do returns( T.nilable( - FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployeeDeductions + FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployeeDeductions ) ) end @@ -1736,19 +1937,16 @@ module FinchAPI sig do params( - employee_deductions: T.any( - FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployeeDeductions, - FinchAPI::Internal::AnyHash - ) - ) - .void + employee_deductions: + FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployeeDeductions::OrHash + ).void end attr_writer :employee_deductions sig do returns( T.nilable( - FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployerContributions + FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployerContributions ) ) end @@ -1756,12 +1954,9 @@ module FinchAPI sig do params( - employer_contributions: T.any( - FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployerContributions, - FinchAPI::Internal::AnyHash - ) - ) - .void + employer_contributions: + FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployerContributions::OrHash + ).void end attr_writer :employer_contributions @@ -1792,7 +1987,7 @@ module FinchAPI sig do returns( T.nilable( - FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Taxes + FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Taxes ) ) end @@ -1800,12 +1995,9 @@ module FinchAPI sig do params( - taxes: T.any( - FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Taxes, - FinchAPI::Internal::AnyHash - ) - ) - .void + taxes: + FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Taxes::OrHash + ).void end attr_writer :taxes @@ -1823,30 +2015,21 @@ module FinchAPI sig do params( - earnings: T.any( - FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Earnings, - FinchAPI::Internal::AnyHash - ), - employee_deductions: T.any( - FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployeeDeductions, - FinchAPI::Internal::AnyHash - ), - employer_contributions: T.any( - FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployerContributions, - FinchAPI::Internal::AnyHash - ), + earnings: + FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Earnings::OrHash, + employee_deductions: + FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployeeDeductions::OrHash, + employer_contributions: + FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployerContributions::OrHash, gross_pay: T::Boolean, individual_id: T::Boolean, net_pay: T::Boolean, payment_method: T::Boolean, - taxes: T.any( - FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Taxes, - FinchAPI::Internal::AnyHash - ), + taxes: + FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Taxes::OrHash, total_hours: T::Boolean, type: T::Boolean - ) - .returns(T.attached_class) + ).returns(T.attached_class) end def self.new( earnings: nil, @@ -1859,27 +2042,38 @@ module FinchAPI taxes: nil, total_hours: nil, type: nil - ); end + ) + end + sig do - override - .returns( - { - 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: T::Boolean, - individual_id: T::Boolean, - net_pay: T::Boolean, - payment_method: T::Boolean, - taxes: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Taxes, - total_hours: T::Boolean, - type: T::Boolean - } - ) + override.returns( + { + earnings: + FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Earnings, + employee_deductions: + FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployeeDeductions, + employer_contributions: + FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployerContributions, + gross_pay: T::Boolean, + individual_id: T::Boolean, + net_pay: T::Boolean, + payment_method: T::Boolean, + taxes: + FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Taxes, + total_hours: T::Boolean, + type: T::Boolean + } + ) + end + def to_hash end - def to_hash; end class Earnings < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any(T.self_type, FinchAPI::Internal::AnyHash) + end + sig { returns(T.nilable(T::Boolean)) } attr_reader :amount @@ -1905,10 +2099,15 @@ module FinchAPI attr_writer :type sig do - params(amount: T::Boolean, currency: T::Boolean, name: T::Boolean, type: T::Boolean) - .returns(T.attached_class) + params( + amount: T::Boolean, + currency: T::Boolean, + name: T::Boolean, + type: T::Boolean + ).returns(T.attached_class) + end + def self.new(amount: nil, currency: nil, name: nil, type: nil) end - def self.new(amount: nil, currency: nil, name: nil, type: nil); end sig do override.returns( @@ -1920,10 +2119,16 @@ module FinchAPI } ) end - def to_hash; end + def to_hash + end end class EmployeeDeductions < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any(T.self_type, FinchAPI::Internal::AnyHash) + end + sig { returns(T.nilable(T::Boolean)) } attr_reader :amount @@ -1961,27 +2166,38 @@ module FinchAPI name: T::Boolean, pre_tax: T::Boolean, type: T::Boolean - ) - .returns(T.attached_class) + ).returns(T.attached_class) + end + def self.new( + amount: nil, + currency: nil, + name: nil, + pre_tax: nil, + type: nil + ) end - def self.new(amount: nil, currency: nil, name: nil, pre_tax: nil, type: nil); end sig do - override - .returns( - { - amount: T::Boolean, - currency: T::Boolean, - name: T::Boolean, - pre_tax: T::Boolean, - type: T::Boolean - } - ) + override.returns( + { + amount: T::Boolean, + currency: T::Boolean, + name: T::Boolean, + pre_tax: T::Boolean, + type: T::Boolean + } + ) + end + def to_hash end - def to_hash; end end class EmployerContributions < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any(T.self_type, FinchAPI::Internal::AnyHash) + end + sig { returns(T.nilable(T::Boolean)) } attr_reader :amount @@ -2001,15 +2217,34 @@ module FinchAPI attr_writer :name sig do - params(amount: T::Boolean, currency: T::Boolean, name: T::Boolean).returns(T.attached_class) + 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 - def self.new(amount: nil, currency: nil, name: nil); end - sig { override.returns({amount: T::Boolean, currency: T::Boolean, name: T::Boolean}) } - def to_hash; end + sig do + override.returns( + { + amount: T::Boolean, + currency: T::Boolean, + name: T::Boolean + } + ) + end + def to_hash + end end class Taxes < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any(T.self_type, FinchAPI::Internal::AnyHash) + end + sig { returns(T.nilable(T::Boolean)) } attr_reader :amount @@ -2047,29 +2282,38 @@ module FinchAPI employer: T::Boolean, name: T::Boolean, type: T::Boolean - ) - .returns(T.attached_class) + ).returns(T.attached_class) + end + def self.new( + amount: nil, + currency: nil, + employer: nil, + name: nil, + type: nil + ) end - def self.new(amount: nil, currency: nil, employer: nil, name: nil, type: nil); end sig do - override - .returns( - { - amount: T::Boolean, - currency: T::Boolean, - employer: T::Boolean, - name: T::Boolean, - type: T::Boolean - } - ) + override.returns( + { + amount: T::Boolean, + currency: T::Boolean, + employer: T::Boolean, + name: T::Boolean, + type: T::Boolean + } + ) + end + def to_hash end - def to_hash; end end end end class Payment < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + sig { returns(T.nilable(T::Boolean)) } attr_reader :id @@ -2136,17 +2380,20 @@ module FinchAPI sig { params(pay_group_ids: T::Boolean).void } attr_writer :pay_group_ids - sig { returns(T.nilable(FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Payment::PayPeriod)) } + sig do + returns( + T.nilable( + FinchAPI::Provider::AuthenticationMethod::SupportedFields::Payment::PayPeriod + ) + ) + end attr_reader :pay_period sig do params( - pay_period: T.any( - FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Payment::PayPeriod, - FinchAPI::Internal::AnyHash - ) - ) - .void + pay_period: + FinchAPI::Provider::AuthenticationMethod::SupportedFields::Payment::PayPeriod::OrHash + ).void end attr_writer :pay_period @@ -2163,12 +2410,9 @@ module FinchAPI pay_date: T::Boolean, pay_frequencies: T::Boolean, pay_group_ids: T::Boolean, - pay_period: T.any( - FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Payment::PayPeriod, - FinchAPI::Internal::AnyHash - ) - ) - .returns(T.attached_class) + pay_period: + FinchAPI::Provider::AuthenticationMethod::SupportedFields::Payment::PayPeriod::OrHash + ).returns(T.attached_class) end def self.new( id: nil, @@ -2183,29 +2427,35 @@ module FinchAPI pay_frequencies: nil, pay_group_ids: nil, pay_period: nil - ); end + ) + end + sig do - override - .returns( - { - id: T::Boolean, - company_debit: T::Boolean, - debit_date: T::Boolean, - employee_taxes: T::Boolean, - employer_taxes: T::Boolean, - gross_pay: T::Boolean, - individual_ids: T::Boolean, - net_pay: T::Boolean, - pay_date: T::Boolean, - pay_frequencies: T::Boolean, - pay_group_ids: T::Boolean, - pay_period: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Payment::PayPeriod - } - ) + override.returns( + { + id: T::Boolean, + company_debit: T::Boolean, + debit_date: T::Boolean, + employee_taxes: T::Boolean, + employer_taxes: T::Boolean, + gross_pay: T::Boolean, + individual_ids: T::Boolean, + net_pay: T::Boolean, + pay_date: T::Boolean, + pay_frequencies: T::Boolean, + pay_group_ids: T::Boolean, + pay_period: + FinchAPI::Provider::AuthenticationMethod::SupportedFields::Payment::PayPeriod + } + ) + end + def to_hash end - def to_hash; end class PayPeriod < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + sig { returns(T.nilable(T::Boolean)) } attr_reader :end_date @@ -2218,11 +2468,21 @@ module FinchAPI 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); end + sig do + params(end_date: T::Boolean, start_date: T::Boolean).returns( + T.attached_class + ) + end + def self.new(end_date: nil, start_date: nil) + end - sig { override.returns({end_date: T::Boolean, start_date: T::Boolean}) } - def to_hash; end + sig do + override.returns( + { end_date: T::Boolean, start_date: T::Boolean } + ) + end + def to_hash + end end end end @@ -2231,18 +2491,47 @@ module FinchAPI module Type extend FinchAPI::Internal::Type::Enum - TaggedSymbol = T.type_alias { T.all(Symbol, FinchAPI::Models::Provider::AuthenticationMethod::Type) } + TaggedSymbol = + T.type_alias do + T.all(Symbol, FinchAPI::Provider::AuthenticationMethod::Type) + end OrSymbol = T.type_alias { T.any(Symbol, String) } - 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) + ASSISTED = + T.let( + :assisted, + FinchAPI::Provider::AuthenticationMethod::Type::TaggedSymbol + ) + CREDENTIAL = + T.let( + :credential, + FinchAPI::Provider::AuthenticationMethod::Type::TaggedSymbol + ) + API_TOKEN = + T.let( + :api_token, + FinchAPI::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) + T.let( + :api_credential, + FinchAPI::Provider::AuthenticationMethod::Type::TaggedSymbol + ) + OAUTH = + T.let( + :oauth, + FinchAPI::Provider::AuthenticationMethod::Type::TaggedSymbol + ) - sig { override.returns(T::Array[FinchAPI::Models::Provider::AuthenticationMethod::Type::TaggedSymbol]) } - def self.values; end + sig do + override.returns( + T::Array[ + FinchAPI::Provider::AuthenticationMethod::Type::TaggedSymbol + ] + ) + end + def self.values + end end end end diff --git a/rbi/finch_api/models/provider_list_params.rbi b/rbi/finch_api/models/provider_list_params.rbi index 072c398b..ca67a1b1 100644 --- a/rbi/finch_api/models/provider_list_params.rbi +++ b/rbi/finch_api/models/provider_list_params.rbi @@ -6,14 +6,19 @@ module FinchAPI extend FinchAPI::Internal::Type::RequestParameters::Converter include FinchAPI::Internal::Type::RequestParameters + OrHash = T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + sig do - params(request_options: T.any(FinchAPI::RequestOptions, FinchAPI::Internal::AnyHash)) - .returns(T.attached_class) + params(request_options: FinchAPI::RequestOptions::OrHash).returns( + T.attached_class + ) + end + def self.new(request_options: {}) end - def self.new(request_options: {}); end - sig { override.returns({request_options: FinchAPI::RequestOptions}) } - def to_hash; end + sig { override.returns({ request_options: FinchAPI::RequestOptions }) } + def to_hash + end end end end diff --git a/rbi/finch_api/models/request_forwarding_forward_params.rbi b/rbi/finch_api/models/request_forwarding_forward_params.rbi index ec09ce79..8ec580dd 100644 --- a/rbi/finch_api/models/request_forwarding_forward_params.rbi +++ b/rbi/finch_api/models/request_forwarding_forward_params.rbi @@ -6,6 +6,8 @@ module FinchAPI extend FinchAPI::Internal::Type::RequestParameters::Converter include FinchAPI::Internal::Type::RequestParameters + OrHash = T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + # The HTTP method for the forwarded request. Valid values include: `GET` , `POST` # , `PUT` , `DELETE` , and `PATCH`. sig { returns(String) } @@ -40,9 +42,8 @@ module FinchAPI data: T.nilable(String), headers: T.nilable(T.anything), params: T.nilable(T.anything), - request_options: T.any(FinchAPI::RequestOptions, FinchAPI::Internal::AnyHash) - ) - .returns(T.attached_class) + request_options: FinchAPI::RequestOptions::OrHash + ).returns(T.attached_class) end def self.new( # The HTTP method for the forwarded request. Valid values include: `GET` , `POST` @@ -63,21 +64,23 @@ module FinchAPI # a valid JSON object rather than a query string. params: nil, request_options: {} - ); end + ) + end + sig do - override - .returns( - { - method_: String, - route: String, - data: T.nilable(String), - headers: T.nilable(T.anything), - params: T.nilable(T.anything), - request_options: FinchAPI::RequestOptions - } - ) + override.returns( + { + method_: String, + route: String, + data: T.nilable(String), + headers: T.nilable(T.anything), + params: T.nilable(T.anything), + request_options: FinchAPI::RequestOptions + } + ) + end + def to_hash end - def to_hash; end end end end diff --git a/rbi/finch_api/models/request_forwarding_forward_response.rbi b/rbi/finch_api/models/request_forwarding_forward_response.rbi index b1b653a7..2c0ac2e7 100644 --- a/rbi/finch_api/models/request_forwarding_forward_response.rbi +++ b/rbi/finch_api/models/request_forwarding_forward_response.rbi @@ -3,6 +3,8 @@ module FinchAPI module Models class RequestForwardingForwardResponse < FinchAPI::Internal::Type::BaseModel + OrHash = T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + # 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. @@ -16,14 +18,16 @@ module FinchAPI # An object containing details of your original forwarded request, for your ease # of reference. - sig { returns(FinchAPI::Models::RequestForwardingForwardResponse::Request) } + sig do + returns(FinchAPI::Models::RequestForwardingForwardResponse::Request) + end attr_reader :request sig do params( - request: T.any(FinchAPI::Models::RequestForwardingForwardResponse::Request, FinchAPI::Internal::AnyHash) - ) - .void + request: + FinchAPI::Models::RequestForwardingForwardResponse::Request::OrHash + ).void end attr_writer :request @@ -36,10 +40,10 @@ module FinchAPI params( data: T.nilable(String), headers: T.nilable(T.anything), - request: T.any(FinchAPI::Models::RequestForwardingForwardResponse::Request, FinchAPI::Internal::AnyHash), + request: + FinchAPI::Models::RequestForwardingForwardResponse::Request::OrHash, status_code: Integer - ) - .returns(T.attached_class) + ).returns(T.attached_class) end def self.new( # A string representation of the HTTP response body of the forwarded request’s @@ -55,21 +59,27 @@ module FinchAPI # 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. status_code: - ); end + ) + end + sig do - override - .returns( - { - data: T.nilable(String), - headers: T.nilable(T.anything), - request: FinchAPI::Models::RequestForwardingForwardResponse::Request, - status_code: Integer - } - ) + override.returns( + { + data: T.nilable(String), + headers: T.nilable(T.anything), + request: + FinchAPI::Models::RequestForwardingForwardResponse::Request, + status_code: Integer + } + ) + end + def to_hash end - def to_hash; end class Request < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + # 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. @@ -104,8 +114,7 @@ module FinchAPI method_: String, params: T.nilable(T.anything), route: String - ) - .returns(T.attached_class) + ).returns(T.attached_class) end def self.new( # The body that was specified for the forwarded request. If a value was not @@ -123,20 +132,22 @@ module FinchAPI params:, # The URL route path that was specified for the forwarded request. route: - ); end + ) + end + sig do - override - .returns( - { - data: T.nilable(String), - headers: T.nilable(T.anything), - method_: String, - params: T.nilable(T.anything), - route: String - } - ) + override.returns( + { + data: T.nilable(String), + headers: T.nilable(T.anything), + method_: String, + params: T.nilable(T.anything), + route: String + } + ) + end + def to_hash end - def to_hash; end end end end diff --git a/rbi/finch_api/models/sandbox/company_update_params.rbi b/rbi/finch_api/models/sandbox/company_update_params.rbi index adf10910..58410a68 100644 --- a/rbi/finch_api/models/sandbox/company_update_params.rbi +++ b/rbi/finch_api/models/sandbox/company_update_params.rbi @@ -7,12 +7,27 @@ module FinchAPI extend FinchAPI::Internal::Type::RequestParameters::Converter include FinchAPI::Internal::Type::RequestParameters + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + # An array of bank account objects associated with the payroll/HRIS system. - sig { returns(T.nilable(T::Array[FinchAPI::Models::Sandbox::CompanyUpdateParams::Account])) } + sig do + returns( + T.nilable(T::Array[FinchAPI::Sandbox::CompanyUpdateParams::Account]) + ) + end attr_accessor :accounts # The array of company departments. - sig { returns(T.nilable(T::Array[T.nilable(FinchAPI::Models::Sandbox::CompanyUpdateParams::Department)])) } + sig do + returns( + T.nilable( + T::Array[ + T.nilable(FinchAPI::Sandbox::CompanyUpdateParams::Department) + ] + ) + ) + end attr_accessor :departments # The employer identification number. @@ -20,14 +35,16 @@ module FinchAPI attr_accessor :ein # The entity type object. - sig { returns(T.nilable(FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity)) } + sig do + returns(T.nilable(FinchAPI::Sandbox::CompanyUpdateParams::Entity)) + end attr_reader :entity sig do params( - entity: T.nilable(T.any(FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity, FinchAPI::Internal::AnyHash)) - ) - .void + entity: + T.nilable(FinchAPI::Sandbox::CompanyUpdateParams::Entity::OrHash) + ).void end attr_writer :entity @@ -35,7 +52,7 @@ module FinchAPI sig { returns(T.nilable(String)) } attr_accessor :legal_name - sig { returns(T.nilable(T::Array[T.nilable(FinchAPI::Models::Location)])) } + sig { returns(T.nilable(T::Array[T.nilable(FinchAPI::Location)])) } attr_accessor :locations # The email of the main administrator on the account. @@ -49,21 +66,30 @@ module FinchAPI sig do params( - accounts: T.nilable( - T::Array[T.any(FinchAPI::Models::Sandbox::CompanyUpdateParams::Account, FinchAPI::Internal::AnyHash)] - ), - departments: T.nilable( - T::Array[T.nilable(T.any(FinchAPI::Models::Sandbox::CompanyUpdateParams::Department, FinchAPI::Internal::AnyHash))] - ), + accounts: + T.nilable( + T::Array[ + FinchAPI::Sandbox::CompanyUpdateParams::Account::OrHash + ] + ), + departments: + T.nilable( + T::Array[ + T.nilable( + FinchAPI::Sandbox::CompanyUpdateParams::Department::OrHash + ) + ] + ), ein: T.nilable(String), - entity: T.nilable(T.any(FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity, FinchAPI::Internal::AnyHash)), + entity: + T.nilable(FinchAPI::Sandbox::CompanyUpdateParams::Entity::OrHash), legal_name: T.nilable(String), - locations: T.nilable(T::Array[T.nilable(T.any(FinchAPI::Models::Location, FinchAPI::Internal::AnyHash))]), + locations: + T.nilable(T::Array[T.nilable(FinchAPI::Location::OrHash)]), primary_email: T.nilable(String), primary_phone_number: T.nilable(String), - request_options: T.any(FinchAPI::RequestOptions, FinchAPI::Internal::AnyHash) - ) - .returns(T.attached_class) + request_options: FinchAPI::RequestOptions::OrHash + ).returns(T.attached_class) end def self.new( # An array of bank account objects associated with the payroll/HRIS system. @@ -83,26 +109,41 @@ module FinchAPI # extension where applicable, e.g. `+NNNNNNNNNNN xExtension` primary_phone_number:, request_options: {} - ); end + ) + end + sig do - override - .returns( - { - 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), - 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: FinchAPI::RequestOptions - } - ) + override.returns( + { + accounts: + T.nilable( + T::Array[FinchAPI::Sandbox::CompanyUpdateParams::Account] + ), + departments: + T.nilable( + T::Array[ + T.nilable( + FinchAPI::Sandbox::CompanyUpdateParams::Department + ) + ] + ), + ein: T.nilable(String), + entity: T.nilable(FinchAPI::Sandbox::CompanyUpdateParams::Entity), + legal_name: T.nilable(String), + locations: T.nilable(T::Array[T.nilable(FinchAPI::Location)]), + primary_email: T.nilable(String), + primary_phone_number: T.nilable(String), + request_options: FinchAPI::RequestOptions + } + ) + end + def to_hash end - def to_hash; end class Account < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + # The name of the bank associated in the payroll/HRIS system. sig { returns(T.nilable(String)) } attr_accessor :account_name @@ -112,7 +153,13 @@ module FinchAPI attr_accessor :account_number # The type of bank account. - sig { returns(T.nilable(FinchAPI::Models::Sandbox::CompanyUpdateParams::Account::AccountType::OrSymbol)) } + sig do + returns( + T.nilable( + FinchAPI::Sandbox::CompanyUpdateParams::Account::AccountType::OrSymbol + ) + ) + end attr_accessor :account_type # Name of the banking institution. @@ -128,11 +175,13 @@ module FinchAPI params( account_name: T.nilable(String), account_number: T.nilable(String), - account_type: T.nilable(FinchAPI::Models::Sandbox::CompanyUpdateParams::Account::AccountType::OrSymbol), + account_type: + T.nilable( + FinchAPI::Sandbox::CompanyUpdateParams::Account::AccountType::OrSymbol + ), institution_name: T.nilable(String), routing_number: T.nilable(String) - ) - .returns(T.attached_class) + ).returns(T.attached_class) end def self.new( # The name of the bank associated in the payroll/HRIS system. @@ -146,88 +195,125 @@ module FinchAPI # A nine-digit code that's based on the U.S. Bank location where your account was # opened. routing_number: nil - ); end + ) + end + sig do - override - .returns( - { - account_name: T.nilable(String), - account_number: T.nilable(String), - account_type: T.nilable(FinchAPI::Models::Sandbox::CompanyUpdateParams::Account::AccountType::OrSymbol), - institution_name: T.nilable(String), - routing_number: T.nilable(String) - } - ) + override.returns( + { + account_name: T.nilable(String), + account_number: T.nilable(String), + account_type: + T.nilable( + FinchAPI::Sandbox::CompanyUpdateParams::Account::AccountType::OrSymbol + ), + institution_name: T.nilable(String), + routing_number: T.nilable(String) + } + ) + end + def to_hash end - def to_hash; end # The type of bank account. module AccountType extend FinchAPI::Internal::Type::Enum TaggedSymbol = - T.type_alias { T.all(Symbol, FinchAPI::Models::Sandbox::CompanyUpdateParams::Account::AccountType) } + T.type_alias do + T.all( + Symbol, + FinchAPI::Sandbox::CompanyUpdateParams::Account::AccountType + ) + end OrSymbol = T.type_alias { T.any(Symbol, String) } CHECKING = - T.let(:checking, FinchAPI::Models::Sandbox::CompanyUpdateParams::Account::AccountType::TaggedSymbol) + T.let( + :checking, + FinchAPI::Sandbox::CompanyUpdateParams::Account::AccountType::TaggedSymbol + ) SAVINGS = - T.let(:savings, FinchAPI::Models::Sandbox::CompanyUpdateParams::Account::AccountType::TaggedSymbol) + T.let( + :savings, + FinchAPI::Sandbox::CompanyUpdateParams::Account::AccountType::TaggedSymbol + ) sig do - override - .returns(T::Array[FinchAPI::Models::Sandbox::CompanyUpdateParams::Account::AccountType::TaggedSymbol]) + override.returns( + T::Array[ + FinchAPI::Sandbox::CompanyUpdateParams::Account::AccountType::TaggedSymbol + ] + ) + end + def self.values end - def self.values; end end end class Department < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + # The department name. sig { returns(T.nilable(String)) } attr_accessor :name # The parent department, if present. - sig { returns(T.nilable(FinchAPI::Models::Sandbox::CompanyUpdateParams::Department::Parent)) } + sig do + returns( + T.nilable( + FinchAPI::Sandbox::CompanyUpdateParams::Department::Parent + ) + ) + end attr_reader :parent sig do params( - parent: T.nilable( - T.any(FinchAPI::Models::Sandbox::CompanyUpdateParams::Department::Parent, FinchAPI::Internal::AnyHash) - ) - ) - .void + parent: + T.nilable( + FinchAPI::Sandbox::CompanyUpdateParams::Department::Parent::OrHash + ) + ).void end attr_writer :parent sig do params( name: T.nilable(String), - parent: T.nilable( - T.any(FinchAPI::Models::Sandbox::CompanyUpdateParams::Department::Parent, FinchAPI::Internal::AnyHash) - ) - ) - .returns(T.attached_class) + parent: + T.nilable( + FinchAPI::Sandbox::CompanyUpdateParams::Department::Parent::OrHash + ) + ).returns(T.attached_class) end def self.new( # The department name. name: nil, # The parent department, if present. parent: nil - ); end + ) + end + sig do - override - .returns( - { - name: T.nilable(String), - parent: T.nilable(FinchAPI::Models::Sandbox::CompanyUpdateParams::Department::Parent) - } - ) + override.returns( + { + name: T.nilable(String), + parent: + T.nilable( + FinchAPI::Sandbox::CompanyUpdateParams::Department::Parent + ) + } + ) + end + def to_hash end - def to_hash; end class Parent < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + # The parent department's name. sig { returns(T.nilable(String)) } attr_accessor :name @@ -237,63 +323,115 @@ module FinchAPI def self.new( # The parent department's name. name: nil - ); end - sig { override.returns({name: T.nilable(String)}) } - def to_hash; end + ) + end + + sig { override.returns({ name: T.nilable(String) }) } + def to_hash + end end end class Entity < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + # The tax payer subtype of the company. - sig { returns(T.nilable(FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity::Subtype::OrSymbol)) } + sig do + returns( + T.nilable( + FinchAPI::Sandbox::CompanyUpdateParams::Entity::Subtype::OrSymbol + ) + ) + end attr_accessor :subtype # The tax payer type of the company. - sig { returns(T.nilable(FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity::Type::OrSymbol)) } + sig do + returns( + T.nilable( + FinchAPI::Sandbox::CompanyUpdateParams::Entity::Type::OrSymbol + ) + ) + end attr_accessor :type # The entity type object. 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) + subtype: + T.nilable( + FinchAPI::Sandbox::CompanyUpdateParams::Entity::Subtype::OrSymbol + ), + type: + T.nilable( + FinchAPI::Sandbox::CompanyUpdateParams::Entity::Type::OrSymbol + ) + ).returns(T.attached_class) end def self.new( # The tax payer subtype of the company. subtype: nil, # The tax payer type of the company. type: nil - ); end + ) + end + sig do - override - .returns( - { - subtype: T.nilable(FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity::Subtype::OrSymbol), - type: T.nilable(FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity::Type::OrSymbol) - } - ) + override.returns( + { + subtype: + T.nilable( + FinchAPI::Sandbox::CompanyUpdateParams::Entity::Subtype::OrSymbol + ), + type: + T.nilable( + FinchAPI::Sandbox::CompanyUpdateParams::Entity::Type::OrSymbol + ) + } + ) + end + def to_hash end - def to_hash; end # The tax payer subtype of the company. module Subtype extend FinchAPI::Internal::Type::Enum TaggedSymbol = - T.type_alias { T.all(Symbol, FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity::Subtype) } + T.type_alias do + T.all( + Symbol, + FinchAPI::Sandbox::CompanyUpdateParams::Entity::Subtype + ) + end OrSymbol = T.type_alias { T.any(Symbol, String) } S_CORPORATION = - T.let(:s_corporation, FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity::Subtype::TaggedSymbol) + T.let( + :s_corporation, + FinchAPI::Sandbox::CompanyUpdateParams::Entity::Subtype::TaggedSymbol + ) C_CORPORATION = - T.let(:c_corporation, FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity::Subtype::TaggedSymbol) + T.let( + :c_corporation, + FinchAPI::Sandbox::CompanyUpdateParams::Entity::Subtype::TaggedSymbol + ) B_CORPORATION = - T.let(:b_corporation, FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity::Subtype::TaggedSymbol) + T.let( + :b_corporation, + FinchAPI::Sandbox::CompanyUpdateParams::Entity::Subtype::TaggedSymbol + ) - sig { override.returns(T::Array[FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity::Subtype::TaggedSymbol]) } - def self.values; end + sig do + override.returns( + T::Array[ + FinchAPI::Sandbox::CompanyUpdateParams::Entity::Subtype::TaggedSymbol + ] + ) + end + def self.values + end end # The tax payer type of the company. @@ -301,24 +439,59 @@ module FinchAPI extend FinchAPI::Internal::Type::Enum TaggedSymbol = - T.type_alias { T.all(Symbol, FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity::Type) } + T.type_alias do + T.all( + Symbol, + FinchAPI::Sandbox::CompanyUpdateParams::Entity::Type + ) + end OrSymbol = T.type_alias { T.any(Symbol, String) } - LLC = T.let(:llc, FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity::Type::TaggedSymbol) - LP = T.let(:lp, FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity::Type::TaggedSymbol) + LLC = + T.let( + :llc, + FinchAPI::Sandbox::CompanyUpdateParams::Entity::Type::TaggedSymbol + ) + LP = + T.let( + :lp, + FinchAPI::Sandbox::CompanyUpdateParams::Entity::Type::TaggedSymbol + ) CORPORATION = - T.let(:corporation, FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity::Type::TaggedSymbol) + T.let( + :corporation, + FinchAPI::Sandbox::CompanyUpdateParams::Entity::Type::TaggedSymbol + ) SOLE_PROPRIETOR = - T.let(:sole_proprietor, FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity::Type::TaggedSymbol) + T.let( + :sole_proprietor, + FinchAPI::Sandbox::CompanyUpdateParams::Entity::Type::TaggedSymbol + ) NON_PROFIT = - T.let(:non_profit, FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity::Type::TaggedSymbol) + T.let( + :non_profit, + FinchAPI::Sandbox::CompanyUpdateParams::Entity::Type::TaggedSymbol + ) PARTNERSHIP = - T.let(:partnership, FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity::Type::TaggedSymbol) + T.let( + :partnership, + FinchAPI::Sandbox::CompanyUpdateParams::Entity::Type::TaggedSymbol + ) COOPERATIVE = - T.let(:cooperative, FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity::Type::TaggedSymbol) + T.let( + :cooperative, + FinchAPI::Sandbox::CompanyUpdateParams::Entity::Type::TaggedSymbol + ) - sig { override.returns(T::Array[FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity::Type::TaggedSymbol]) } - def self.values; end + sig do + override.returns( + T::Array[ + FinchAPI::Sandbox::CompanyUpdateParams::Entity::Type::TaggedSymbol + ] + ) + end + def self.values + end end end end diff --git a/rbi/finch_api/models/sandbox/company_update_response.rbi b/rbi/finch_api/models/sandbox/company_update_response.rbi index 7b0ec543..85ff5ddb 100644 --- a/rbi/finch_api/models/sandbox/company_update_response.rbi +++ b/rbi/finch_api/models/sandbox/company_update_response.rbi @@ -4,12 +4,33 @@ module FinchAPI module Models module Sandbox class CompanyUpdateResponse < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + # An array of bank account objects associated with the payroll/HRIS system. - sig { returns(T.nilable(T::Array[FinchAPI::Models::Sandbox::CompanyUpdateResponse::Account])) } + sig do + returns( + T.nilable( + T::Array[ + FinchAPI::Models::Sandbox::CompanyUpdateResponse::Account + ] + ) + ) + end attr_accessor :accounts # The array of company departments. - sig { returns(T.nilable(T::Array[T.nilable(FinchAPI::Models::Sandbox::CompanyUpdateResponse::Department)])) } + sig do + returns( + T.nilable( + T::Array[ + T.nilable( + FinchAPI::Models::Sandbox::CompanyUpdateResponse::Department + ) + ] + ) + ) + end attr_accessor :departments # The employer identification number. @@ -17,14 +38,20 @@ module FinchAPI attr_accessor :ein # The entity type object. - sig { returns(T.nilable(FinchAPI::Models::Sandbox::CompanyUpdateResponse::Entity)) } + sig do + returns( + T.nilable(FinchAPI::Models::Sandbox::CompanyUpdateResponse::Entity) + ) + end attr_reader :entity sig do params( - entity: T.nilable(T.any(FinchAPI::Models::Sandbox::CompanyUpdateResponse::Entity, FinchAPI::Internal::AnyHash)) - ) - .void + entity: + T.nilable( + FinchAPI::Models::Sandbox::CompanyUpdateResponse::Entity::OrHash + ) + ).void end attr_writer :entity @@ -32,7 +59,7 @@ module FinchAPI sig { returns(T.nilable(String)) } attr_accessor :legal_name - sig { returns(T.nilable(T::Array[T.nilable(FinchAPI::Models::Location)])) } + sig { returns(T.nilable(T::Array[T.nilable(FinchAPI::Location)])) } attr_accessor :locations # The email of the main administrator on the account. @@ -46,24 +73,31 @@ module FinchAPI sig do params( - accounts: T.nilable( - T::Array[T.any(FinchAPI::Models::Sandbox::CompanyUpdateResponse::Account, FinchAPI::Internal::AnyHash)] - ), - departments: T.nilable( - T::Array[ - T.nilable( - T.any(FinchAPI::Models::Sandbox::CompanyUpdateResponse::Department, FinchAPI::Internal::AnyHash) - ) - ] - ), + accounts: + T.nilable( + T::Array[ + FinchAPI::Models::Sandbox::CompanyUpdateResponse::Account::OrHash + ] + ), + departments: + T.nilable( + T::Array[ + T.nilable( + FinchAPI::Models::Sandbox::CompanyUpdateResponse::Department::OrHash + ) + ] + ), ein: T.nilable(String), - entity: T.nilable(T.any(FinchAPI::Models::Sandbox::CompanyUpdateResponse::Entity, FinchAPI::Internal::AnyHash)), + entity: + T.nilable( + FinchAPI::Models::Sandbox::CompanyUpdateResponse::Entity::OrHash + ), legal_name: T.nilable(String), - locations: T.nilable(T::Array[T.nilable(T.any(FinchAPI::Models::Location, FinchAPI::Internal::AnyHash))]), + locations: + T.nilable(T::Array[T.nilable(FinchAPI::Location::OrHash)]), primary_email: T.nilable(String), primary_phone_number: T.nilable(String) - ) - .returns(T.attached_class) + ).returns(T.attached_class) end def self.new( # An array of bank account objects associated with the payroll/HRIS system. @@ -82,25 +116,45 @@ module FinchAPI # The phone number of the main administrator on the account. Format: E.164, with # extension where applicable, e.g. `+NNNNNNNNNNN xExtension` primary_phone_number: - ); end + ) + end + sig do - override - .returns( - { - 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), - 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) - } - ) + override.returns( + { + 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 + ), + legal_name: T.nilable(String), + locations: T.nilable(T::Array[T.nilable(FinchAPI::Location)]), + primary_email: T.nilable(String), + primary_phone_number: T.nilable(String) + } + ) + end + def to_hash end - def to_hash; end class Account < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + # The name of the bank associated in the payroll/HRIS system. sig { returns(T.nilable(String)) } attr_accessor :account_name @@ -110,7 +164,13 @@ module FinchAPI attr_accessor :account_number # The type of bank account. - sig { returns(T.nilable(FinchAPI::Models::Sandbox::CompanyUpdateResponse::Account::AccountType::TaggedSymbol)) } + sig do + returns( + T.nilable( + FinchAPI::Models::Sandbox::CompanyUpdateResponse::Account::AccountType::TaggedSymbol + ) + ) + end attr_accessor :account_type # Name of the banking institution. @@ -126,11 +186,13 @@ module FinchAPI params( account_name: T.nilable(String), account_number: T.nilable(String), - account_type: T.nilable(FinchAPI::Models::Sandbox::CompanyUpdateResponse::Account::AccountType::OrSymbol), + account_type: + T.nilable( + FinchAPI::Models::Sandbox::CompanyUpdateResponse::Account::AccountType::OrSymbol + ), institution_name: T.nilable(String), routing_number: T.nilable(String) - ) - .returns(T.attached_class) + ).returns(T.attached_class) end def self.new( # The name of the bank associated in the payroll/HRIS system. @@ -144,88 +206,125 @@ module FinchAPI # A nine-digit code that's based on the U.S. Bank location where your account was # opened. routing_number: nil - ); end + ) + end + sig do - override - .returns( - { - account_name: T.nilable(String), - account_number: T.nilable(String), - account_type: T.nilable(FinchAPI::Models::Sandbox::CompanyUpdateResponse::Account::AccountType::TaggedSymbol), - institution_name: T.nilable(String), - routing_number: T.nilable(String) - } - ) + override.returns( + { + account_name: T.nilable(String), + account_number: T.nilable(String), + account_type: + T.nilable( + FinchAPI::Models::Sandbox::CompanyUpdateResponse::Account::AccountType::TaggedSymbol + ), + institution_name: T.nilable(String), + routing_number: T.nilable(String) + } + ) + end + def to_hash end - def to_hash; end # The type of bank account. module AccountType extend FinchAPI::Internal::Type::Enum TaggedSymbol = - T.type_alias { T.all(Symbol, FinchAPI::Models::Sandbox::CompanyUpdateResponse::Account::AccountType) } + T.type_alias do + T.all( + Symbol, + FinchAPI::Models::Sandbox::CompanyUpdateResponse::Account::AccountType + ) + end OrSymbol = T.type_alias { T.any(Symbol, String) } CHECKING = - T.let(:checking, FinchAPI::Models::Sandbox::CompanyUpdateResponse::Account::AccountType::TaggedSymbol) + T.let( + :checking, + FinchAPI::Models::Sandbox::CompanyUpdateResponse::Account::AccountType::TaggedSymbol + ) SAVINGS = - T.let(:savings, FinchAPI::Models::Sandbox::CompanyUpdateResponse::Account::AccountType::TaggedSymbol) + T.let( + :savings, + FinchAPI::Models::Sandbox::CompanyUpdateResponse::Account::AccountType::TaggedSymbol + ) sig do - override - .returns(T::Array[FinchAPI::Models::Sandbox::CompanyUpdateResponse::Account::AccountType::TaggedSymbol]) + override.returns( + T::Array[ + FinchAPI::Models::Sandbox::CompanyUpdateResponse::Account::AccountType::TaggedSymbol + ] + ) + end + def self.values end - def self.values; end end end class Department < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + # The department name. sig { returns(T.nilable(String)) } attr_accessor :name # The parent department, if present. - sig { returns(T.nilable(FinchAPI::Models::Sandbox::CompanyUpdateResponse::Department::Parent)) } + sig do + returns( + T.nilable( + FinchAPI::Models::Sandbox::CompanyUpdateResponse::Department::Parent + ) + ) + end attr_reader :parent sig do params( - parent: T.nilable( - T.any(FinchAPI::Models::Sandbox::CompanyUpdateResponse::Department::Parent, FinchAPI::Internal::AnyHash) - ) - ) - .void + parent: + T.nilable( + FinchAPI::Models::Sandbox::CompanyUpdateResponse::Department::Parent::OrHash + ) + ).void end attr_writer :parent sig do params( name: T.nilable(String), - parent: T.nilable( - T.any(FinchAPI::Models::Sandbox::CompanyUpdateResponse::Department::Parent, FinchAPI::Internal::AnyHash) - ) - ) - .returns(T.attached_class) + parent: + T.nilable( + FinchAPI::Models::Sandbox::CompanyUpdateResponse::Department::Parent::OrHash + ) + ).returns(T.attached_class) end def self.new( # The department name. name: nil, # The parent department, if present. parent: nil - ); end + ) + end + sig do - override - .returns( - { - name: T.nilable(String), - parent: T.nilable(FinchAPI::Models::Sandbox::CompanyUpdateResponse::Department::Parent) - } - ) + override.returns( + { + name: T.nilable(String), + parent: + T.nilable( + FinchAPI::Models::Sandbox::CompanyUpdateResponse::Department::Parent + ) + } + ) + end + def to_hash end - def to_hash; end class Parent < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + # The parent department's name. sig { returns(T.nilable(String)) } attr_accessor :name @@ -235,65 +334,115 @@ module FinchAPI def self.new( # The parent department's name. name: nil - ); end - sig { override.returns({name: T.nilable(String)}) } - def to_hash; end + ) + end + + sig { override.returns({ name: T.nilable(String) }) } + def to_hash + end end end class Entity < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + # The tax payer subtype of the company. - sig { returns(T.nilable(FinchAPI::Models::Sandbox::CompanyUpdateResponse::Entity::Subtype::TaggedSymbol)) } + sig do + returns( + T.nilable( + FinchAPI::Models::Sandbox::CompanyUpdateResponse::Entity::Subtype::TaggedSymbol + ) + ) + end attr_accessor :subtype # The tax payer type of the company. - sig { returns(T.nilable(FinchAPI::Models::Sandbox::CompanyUpdateResponse::Entity::Type::TaggedSymbol)) } + sig do + returns( + T.nilable( + FinchAPI::Models::Sandbox::CompanyUpdateResponse::Entity::Type::TaggedSymbol + ) + ) + end attr_accessor :type # The entity type object. sig do params( - subtype: T.nilable(FinchAPI::Models::Sandbox::CompanyUpdateResponse::Entity::Subtype::OrSymbol), - type: T.nilable(FinchAPI::Models::Sandbox::CompanyUpdateResponse::Entity::Type::OrSymbol) - ) - .returns(T.attached_class) + 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 def self.new( # The tax payer subtype of the company. subtype: nil, # The tax payer type of the company. type: nil - ); end + ) + end + sig do - override - .returns( - { - subtype: T.nilable(FinchAPI::Models::Sandbox::CompanyUpdateResponse::Entity::Subtype::TaggedSymbol), - type: T.nilable(FinchAPI::Models::Sandbox::CompanyUpdateResponse::Entity::Type::TaggedSymbol) - } - ) + 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 - def to_hash; end # The tax payer subtype of the company. module Subtype extend FinchAPI::Internal::Type::Enum TaggedSymbol = - T.type_alias { T.all(Symbol, FinchAPI::Models::Sandbox::CompanyUpdateResponse::Entity::Subtype) } + T.type_alias do + T.all( + Symbol, + FinchAPI::Models::Sandbox::CompanyUpdateResponse::Entity::Subtype + ) + end OrSymbol = T.type_alias { T.any(Symbol, String) } S_CORPORATION = - T.let(:s_corporation, FinchAPI::Models::Sandbox::CompanyUpdateResponse::Entity::Subtype::TaggedSymbol) + T.let( + :s_corporation, + FinchAPI::Models::Sandbox::CompanyUpdateResponse::Entity::Subtype::TaggedSymbol + ) C_CORPORATION = - T.let(:c_corporation, FinchAPI::Models::Sandbox::CompanyUpdateResponse::Entity::Subtype::TaggedSymbol) + T.let( + :c_corporation, + FinchAPI::Models::Sandbox::CompanyUpdateResponse::Entity::Subtype::TaggedSymbol + ) B_CORPORATION = - T.let(:b_corporation, FinchAPI::Models::Sandbox::CompanyUpdateResponse::Entity::Subtype::TaggedSymbol) + T.let( + :b_corporation, + FinchAPI::Models::Sandbox::CompanyUpdateResponse::Entity::Subtype::TaggedSymbol + ) sig do - override.returns(T::Array[FinchAPI::Models::Sandbox::CompanyUpdateResponse::Entity::Subtype::TaggedSymbol]) + override.returns( + T::Array[ + FinchAPI::Models::Sandbox::CompanyUpdateResponse::Entity::Subtype::TaggedSymbol + ] + ) + end + def self.values end - def self.values; end end # The tax payer type of the company. @@ -301,24 +450,59 @@ module FinchAPI extend FinchAPI::Internal::Type::Enum TaggedSymbol = - T.type_alias { T.all(Symbol, FinchAPI::Models::Sandbox::CompanyUpdateResponse::Entity::Type) } + T.type_alias do + T.all( + Symbol, + FinchAPI::Models::Sandbox::CompanyUpdateResponse::Entity::Type + ) + end OrSymbol = T.type_alias { T.any(Symbol, String) } - LLC = T.let(:llc, FinchAPI::Models::Sandbox::CompanyUpdateResponse::Entity::Type::TaggedSymbol) - LP = T.let(:lp, 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) + T.let( + :corporation, + FinchAPI::Models::Sandbox::CompanyUpdateResponse::Entity::Type::TaggedSymbol + ) SOLE_PROPRIETOR = - T.let(:sole_proprietor, FinchAPI::Models::Sandbox::CompanyUpdateResponse::Entity::Type::TaggedSymbol) + T.let( + :sole_proprietor, + FinchAPI::Models::Sandbox::CompanyUpdateResponse::Entity::Type::TaggedSymbol + ) NON_PROFIT = - T.let(:non_profit, FinchAPI::Models::Sandbox::CompanyUpdateResponse::Entity::Type::TaggedSymbol) + T.let( + :non_profit, + FinchAPI::Models::Sandbox::CompanyUpdateResponse::Entity::Type::TaggedSymbol + ) PARTNERSHIP = - T.let(:partnership, FinchAPI::Models::Sandbox::CompanyUpdateResponse::Entity::Type::TaggedSymbol) + T.let( + :partnership, + FinchAPI::Models::Sandbox::CompanyUpdateResponse::Entity::Type::TaggedSymbol + ) COOPERATIVE = - T.let(:cooperative, FinchAPI::Models::Sandbox::CompanyUpdateResponse::Entity::Type::TaggedSymbol) + T.let( + :cooperative, + FinchAPI::Models::Sandbox::CompanyUpdateResponse::Entity::Type::TaggedSymbol + ) - sig { override.returns(T::Array[FinchAPI::Models::Sandbox::CompanyUpdateResponse::Entity::Type::TaggedSymbol]) } - def self.values; end + sig do + override.returns( + T::Array[ + FinchAPI::Models::Sandbox::CompanyUpdateResponse::Entity::Type::TaggedSymbol + ] + ) + end + def self.values + end end end end diff --git a/rbi/finch_api/models/sandbox/connection_create_params.rbi b/rbi/finch_api/models/sandbox/connection_create_params.rbi index e7eefc04..122ace5b 100644 --- a/rbi/finch_api/models/sandbox/connection_create_params.rbi +++ b/rbi/finch_api/models/sandbox/connection_create_params.rbi @@ -7,18 +7,27 @@ module FinchAPI extend FinchAPI::Internal::Type::RequestParameters::Converter include FinchAPI::Internal::Type::RequestParameters + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + # The provider associated with the connection sig { returns(String) } attr_accessor :provider_id - sig { returns(T.nilable(FinchAPI::Models::Sandbox::ConnectionCreateParams::AuthenticationType::OrSymbol)) } + sig do + returns( + T.nilable( + FinchAPI::Sandbox::ConnectionCreateParams::AuthenticationType::OrSymbol + ) + ) + end attr_reader :authentication_type sig do params( - authentication_type: FinchAPI::Models::Sandbox::ConnectionCreateParams::AuthenticationType::OrSymbol - ) - .void + authentication_type: + FinchAPI::Sandbox::ConnectionCreateParams::AuthenticationType::OrSymbol + ).void end attr_writer :authentication_type @@ -40,12 +49,12 @@ module FinchAPI sig do params( provider_id: String, - authentication_type: FinchAPI::Models::Sandbox::ConnectionCreateParams::AuthenticationType::OrSymbol, + authentication_type: + FinchAPI::Sandbox::ConnectionCreateParams::AuthenticationType::OrSymbol, employee_size: Integer, products: T::Array[String], - request_options: T.any(FinchAPI::RequestOptions, FinchAPI::Internal::AnyHash) - ) - .returns(T.attached_class) + request_options: FinchAPI::RequestOptions::OrHash + ).returns(T.attached_class) end def self.new( # The provider associated with the connection @@ -57,42 +66,66 @@ module FinchAPI employee_size: nil, products: nil, request_options: {} - ); end + ) + end + sig do - override - .returns( - { - provider_id: String, - authentication_type: FinchAPI::Models::Sandbox::ConnectionCreateParams::AuthenticationType::OrSymbol, - employee_size: Integer, - products: T::Array[String], - request_options: FinchAPI::RequestOptions - } - ) + override.returns( + { + provider_id: String, + authentication_type: + FinchAPI::Sandbox::ConnectionCreateParams::AuthenticationType::OrSymbol, + employee_size: Integer, + products: T::Array[String], + request_options: FinchAPI::RequestOptions + } + ) + end + def to_hash end - def to_hash; end module AuthenticationType extend FinchAPI::Internal::Type::Enum TaggedSymbol = - T.type_alias { T.all(Symbol, FinchAPI::Models::Sandbox::ConnectionCreateParams::AuthenticationType) } + T.type_alias do + T.all( + Symbol, + FinchAPI::Sandbox::ConnectionCreateParams::AuthenticationType + ) + end OrSymbol = T.type_alias { T.any(Symbol, String) } CREDENTIAL = - T.let(:credential, FinchAPI::Models::Sandbox::ConnectionCreateParams::AuthenticationType::TaggedSymbol) + T.let( + :credential, + FinchAPI::Sandbox::ConnectionCreateParams::AuthenticationType::TaggedSymbol + ) API_TOKEN = - T.let(:api_token, FinchAPI::Models::Sandbox::ConnectionCreateParams::AuthenticationType::TaggedSymbol) + T.let( + :api_token, + FinchAPI::Sandbox::ConnectionCreateParams::AuthenticationType::TaggedSymbol + ) OAUTH = - T.let(:oauth, FinchAPI::Models::Sandbox::ConnectionCreateParams::AuthenticationType::TaggedSymbol) + T.let( + :oauth, + FinchAPI::Sandbox::ConnectionCreateParams::AuthenticationType::TaggedSymbol + ) ASSISTED = - T.let(:assisted, FinchAPI::Models::Sandbox::ConnectionCreateParams::AuthenticationType::TaggedSymbol) + T.let( + :assisted, + FinchAPI::Sandbox::ConnectionCreateParams::AuthenticationType::TaggedSymbol + ) sig do - override - .returns(T::Array[FinchAPI::Models::Sandbox::ConnectionCreateParams::AuthenticationType::TaggedSymbol]) + override.returns( + T::Array[ + FinchAPI::Sandbox::ConnectionCreateParams::AuthenticationType::TaggedSymbol + ] + ) + end + def self.values end - def self.values; end end end end diff --git a/rbi/finch_api/models/sandbox/connection_create_response.rbi b/rbi/finch_api/models/sandbox/connection_create_response.rbi index 48c4b5bd..d6ded80c 100644 --- a/rbi/finch_api/models/sandbox/connection_create_response.rbi +++ b/rbi/finch_api/models/sandbox/connection_create_response.rbi @@ -4,6 +4,9 @@ module FinchAPI module Models module Sandbox class ConnectionCreateResponse < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + sig { returns(String) } attr_accessor :access_token @@ -11,7 +14,11 @@ module FinchAPI sig { returns(String) } attr_accessor :account_id - sig { returns(FinchAPI::Models::Sandbox::ConnectionCreateResponse::AuthenticationType::TaggedSymbol) } + sig do + returns( + FinchAPI::Models::Sandbox::ConnectionCreateResponse::AuthenticationType::TaggedSymbol + ) + end attr_accessor :authentication_type # [DEPRECATED] Use `connection_id` to associate a connection with an access token @@ -39,14 +46,14 @@ module FinchAPI params( access_token: String, account_id: String, - authentication_type: FinchAPI::Models::Sandbox::ConnectionCreateResponse::AuthenticationType::OrSymbol, + authentication_type: + FinchAPI::Models::Sandbox::ConnectionCreateResponse::AuthenticationType::OrSymbol, company_id: String, connection_id: String, products: T::Array[String], provider_id: String, token_type: String - ) - .returns(T.attached_class) + ).returns(T.attached_class) end def self.new( access_token:, @@ -61,45 +68,69 @@ module FinchAPI # The ID of the provider associated with the `access_token`. provider_id:, token_type: nil - ); end + ) + end + sig do - override - .returns( - { - access_token: String, - account_id: String, - authentication_type: FinchAPI::Models::Sandbox::ConnectionCreateResponse::AuthenticationType::TaggedSymbol, - company_id: String, - connection_id: String, - products: T::Array[String], - provider_id: String, - token_type: String - } - ) + override.returns( + { + access_token: String, + account_id: String, + authentication_type: + FinchAPI::Models::Sandbox::ConnectionCreateResponse::AuthenticationType::TaggedSymbol, + company_id: String, + connection_id: String, + products: T::Array[String], + provider_id: String, + token_type: String + } + ) + end + def to_hash end - def to_hash; end module AuthenticationType extend FinchAPI::Internal::Type::Enum TaggedSymbol = - T.type_alias { T.all(Symbol, FinchAPI::Models::Sandbox::ConnectionCreateResponse::AuthenticationType) } + T.type_alias do + T.all( + Symbol, + FinchAPI::Models::Sandbox::ConnectionCreateResponse::AuthenticationType + ) + end OrSymbol = T.type_alias { T.any(Symbol, String) } CREDENTIAL = - T.let(:credential, FinchAPI::Models::Sandbox::ConnectionCreateResponse::AuthenticationType::TaggedSymbol) + T.let( + :credential, + FinchAPI::Models::Sandbox::ConnectionCreateResponse::AuthenticationType::TaggedSymbol + ) API_TOKEN = - T.let(:api_token, FinchAPI::Models::Sandbox::ConnectionCreateResponse::AuthenticationType::TaggedSymbol) + T.let( + :api_token, + FinchAPI::Models::Sandbox::ConnectionCreateResponse::AuthenticationType::TaggedSymbol + ) OAUTH = - T.let(:oauth, FinchAPI::Models::Sandbox::ConnectionCreateResponse::AuthenticationType::TaggedSymbol) + T.let( + :oauth, + FinchAPI::Models::Sandbox::ConnectionCreateResponse::AuthenticationType::TaggedSymbol + ) ASSISTED = - T.let(:assisted, FinchAPI::Models::Sandbox::ConnectionCreateResponse::AuthenticationType::TaggedSymbol) + T.let( + :assisted, + FinchAPI::Models::Sandbox::ConnectionCreateResponse::AuthenticationType::TaggedSymbol + ) sig do - override - .returns(T::Array[FinchAPI::Models::Sandbox::ConnectionCreateResponse::AuthenticationType::TaggedSymbol]) + override.returns( + T::Array[ + FinchAPI::Models::Sandbox::ConnectionCreateResponse::AuthenticationType::TaggedSymbol + ] + ) + end + def self.values end - def self.values; end end end end diff --git a/rbi/finch_api/models/sandbox/connections/account_create_params.rbi b/rbi/finch_api/models/sandbox/connections/account_create_params.rbi index cfe1afc5..fe57f7df 100644 --- a/rbi/finch_api/models/sandbox/connections/account_create_params.rbi +++ b/rbi/finch_api/models/sandbox/connections/account_create_params.rbi @@ -8,6 +8,9 @@ module FinchAPI extend FinchAPI::Internal::Type::RequestParameters::Converter include FinchAPI::Internal::Type::RequestParameters + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + sig { returns(String) } attr_accessor :company_id @@ -17,16 +20,18 @@ module FinchAPI sig do returns( - T.nilable(FinchAPI::Models::Sandbox::Connections::AccountCreateParams::AuthenticationType::OrSymbol) + T.nilable( + FinchAPI::Sandbox::Connections::AccountCreateParams::AuthenticationType::OrSymbol + ) ) end attr_reader :authentication_type sig do params( - authentication_type: FinchAPI::Models::Sandbox::Connections::AccountCreateParams::AuthenticationType::OrSymbol - ) - .void + authentication_type: + FinchAPI::Sandbox::Connections::AccountCreateParams::AuthenticationType::OrSymbol + ).void end attr_writer :authentication_type @@ -42,11 +47,11 @@ module FinchAPI params( company_id: String, provider_id: String, - authentication_type: FinchAPI::Models::Sandbox::Connections::AccountCreateParams::AuthenticationType::OrSymbol, + authentication_type: + FinchAPI::Sandbox::Connections::AccountCreateParams::AuthenticationType::OrSymbol, products: T::Array[String], - request_options: T.any(FinchAPI::RequestOptions, FinchAPI::Internal::AnyHash) - ) - .returns(T.attached_class) + request_options: FinchAPI::RequestOptions::OrHash + ).returns(T.attached_class) end def self.new( company_id:, @@ -57,56 +62,66 @@ module FinchAPI # `employment`, `individual`) products: nil, request_options: {} - ); end + ) + end + sig do - override - .returns( - { - company_id: String, - provider_id: String, - authentication_type: FinchAPI::Models::Sandbox::Connections::AccountCreateParams::AuthenticationType::OrSymbol, - products: T::Array[String], - request_options: FinchAPI::RequestOptions - } - ) + override.returns( + { + company_id: String, + provider_id: String, + authentication_type: + FinchAPI::Sandbox::Connections::AccountCreateParams::AuthenticationType::OrSymbol, + products: T::Array[String], + request_options: FinchAPI::RequestOptions + } + ) + end + def to_hash end - def to_hash; end module AuthenticationType extend FinchAPI::Internal::Type::Enum TaggedSymbol = - T.type_alias { T.all(Symbol, FinchAPI::Models::Sandbox::Connections::AccountCreateParams::AuthenticationType) } + T.type_alias do + T.all( + Symbol, + FinchAPI::Sandbox::Connections::AccountCreateParams::AuthenticationType + ) + end OrSymbol = T.type_alias { T.any(Symbol, String) } CREDENTIAL = T.let( :credential, - FinchAPI::Models::Sandbox::Connections::AccountCreateParams::AuthenticationType::TaggedSymbol + FinchAPI::Sandbox::Connections::AccountCreateParams::AuthenticationType::TaggedSymbol ) API_TOKEN = T.let( :api_token, - FinchAPI::Models::Sandbox::Connections::AccountCreateParams::AuthenticationType::TaggedSymbol + FinchAPI::Sandbox::Connections::AccountCreateParams::AuthenticationType::TaggedSymbol ) OAUTH = T.let( :oauth, - FinchAPI::Models::Sandbox::Connections::AccountCreateParams::AuthenticationType::TaggedSymbol + FinchAPI::Sandbox::Connections::AccountCreateParams::AuthenticationType::TaggedSymbol ) ASSISTED = T.let( :assisted, - FinchAPI::Models::Sandbox::Connections::AccountCreateParams::AuthenticationType::TaggedSymbol + FinchAPI::Sandbox::Connections::AccountCreateParams::AuthenticationType::TaggedSymbol ) sig do - override - .returns( - T::Array[FinchAPI::Models::Sandbox::Connections::AccountCreateParams::AuthenticationType::TaggedSymbol] - ) + override.returns( + T::Array[ + FinchAPI::Sandbox::Connections::AccountCreateParams::AuthenticationType::TaggedSymbol + ] + ) + end + def self.values end - def self.values; end end end end diff --git a/rbi/finch_api/models/sandbox/connections/account_create_response.rbi b/rbi/finch_api/models/sandbox/connections/account_create_response.rbi index b6d64402..e46aba9a 100644 --- a/rbi/finch_api/models/sandbox/connections/account_create_response.rbi +++ b/rbi/finch_api/models/sandbox/connections/account_create_response.rbi @@ -5,6 +5,9 @@ module FinchAPI module Sandbox module Connections class AccountCreateResponse < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + sig { returns(String) } attr_accessor :access_token @@ -12,7 +15,11 @@ module FinchAPI sig { returns(String) } attr_accessor :account_id - sig { returns(FinchAPI::Models::Sandbox::Connections::AccountCreateResponse::AuthenticationType::TaggedSymbol) } + sig do + returns( + FinchAPI::Models::Sandbox::Connections::AccountCreateResponse::AuthenticationType::TaggedSymbol + ) + end attr_accessor :authentication_type # [DEPRECATED] Use `connection_id` to associate a connection with an access token @@ -34,13 +41,13 @@ module FinchAPI params( access_token: String, account_id: String, - authentication_type: FinchAPI::Models::Sandbox::Connections::AccountCreateResponse::AuthenticationType::OrSymbol, + authentication_type: + FinchAPI::Models::Sandbox::Connections::AccountCreateResponse::AuthenticationType::OrSymbol, company_id: String, connection_id: String, products: T::Array[String], provider_id: String - ) - .returns(T.attached_class) + ).returns(T.attached_class) end def self.new( access_token:, @@ -54,28 +61,36 @@ module FinchAPI products:, # The ID of the provider associated with the `access_token` provider_id: - ); end + ) + end + sig do - override - .returns( - { - access_token: String, - account_id: String, - authentication_type: FinchAPI::Models::Sandbox::Connections::AccountCreateResponse::AuthenticationType::TaggedSymbol, - company_id: String, - connection_id: String, - products: T::Array[String], - provider_id: String - } - ) + override.returns( + { + access_token: String, + account_id: String, + authentication_type: + FinchAPI::Models::Sandbox::Connections::AccountCreateResponse::AuthenticationType::TaggedSymbol, + company_id: String, + connection_id: String, + products: T::Array[String], + provider_id: String + } + ) + end + def to_hash end - def to_hash; end module AuthenticationType extend FinchAPI::Internal::Type::Enum TaggedSymbol = - T.type_alias { T.all(Symbol, FinchAPI::Models::Sandbox::Connections::AccountCreateResponse::AuthenticationType) } + T.type_alias do + T.all( + Symbol, + FinchAPI::Models::Sandbox::Connections::AccountCreateResponse::AuthenticationType + ) + end OrSymbol = T.type_alias { T.any(Symbol, String) } CREDENTIAL = @@ -100,12 +115,14 @@ module FinchAPI ) sig do - override - .returns( - T::Array[FinchAPI::Models::Sandbox::Connections::AccountCreateResponse::AuthenticationType::TaggedSymbol] - ) + override.returns( + T::Array[ + FinchAPI::Models::Sandbox::Connections::AccountCreateResponse::AuthenticationType::TaggedSymbol + ] + ) + end + def self.values end - def self.values; end end end end diff --git a/rbi/finch_api/models/sandbox/connections/account_update_params.rbi b/rbi/finch_api/models/sandbox/connections/account_update_params.rbi index 347a3eb8..6881f0e9 100644 --- a/rbi/finch_api/models/sandbox/connections/account_update_params.rbi +++ b/rbi/finch_api/models/sandbox/connections/account_update_params.rbi @@ -8,31 +8,38 @@ module FinchAPI extend FinchAPI::Internal::Type::RequestParameters::Converter include FinchAPI::Internal::Type::RequestParameters - sig { returns(T.nilable(FinchAPI::Models::ConnectionStatusType::OrSymbol)) } + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + + sig { returns(T.nilable(FinchAPI::ConnectionStatusType::OrSymbol)) } attr_reader :connection_status - sig { params(connection_status: FinchAPI::Models::ConnectionStatusType::OrSymbol).void } + sig do + params( + connection_status: FinchAPI::ConnectionStatusType::OrSymbol + ).void + end attr_writer :connection_status sig do params( - connection_status: FinchAPI::Models::ConnectionStatusType::OrSymbol, - request_options: T.any(FinchAPI::RequestOptions, FinchAPI::Internal::AnyHash) - ) - .returns(T.attached_class) + connection_status: FinchAPI::ConnectionStatusType::OrSymbol, + request_options: FinchAPI::RequestOptions::OrHash + ).returns(T.attached_class) + end + def self.new(connection_status: nil, request_options: {}) end - def self.new(connection_status: nil, request_options: {}); end sig do - override - .returns( - { - connection_status: FinchAPI::Models::ConnectionStatusType::OrSymbol, - request_options: FinchAPI::RequestOptions - } - ) + override.returns( + { + connection_status: FinchAPI::ConnectionStatusType::OrSymbol, + request_options: FinchAPI::RequestOptions + } + ) + end + def to_hash end - def to_hash; end end end end diff --git a/rbi/finch_api/models/sandbox/connections/account_update_response.rbi b/rbi/finch_api/models/sandbox/connections/account_update_response.rbi index 08600c69..346c3537 100644 --- a/rbi/finch_api/models/sandbox/connections/account_update_response.rbi +++ b/rbi/finch_api/models/sandbox/connections/account_update_response.rbi @@ -5,11 +5,18 @@ module FinchAPI module Sandbox module Connections class AccountUpdateResponse < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + # [DEPRECATED] Use `connection_id` to associate a connection with an access token sig { returns(String) } attr_accessor :account_id - sig { returns(FinchAPI::Models::Sandbox::Connections::AccountUpdateResponse::AuthenticationType::TaggedSymbol) } + sig do + returns( + FinchAPI::Models::Sandbox::Connections::AccountUpdateResponse::AuthenticationType::TaggedSymbol + ) + end attr_accessor :authentication_type # [DEPRECATED] Use `connection_id` to associate a connection with an access token @@ -33,13 +40,13 @@ module FinchAPI sig do params( account_id: String, - authentication_type: FinchAPI::Models::Sandbox::Connections::AccountUpdateResponse::AuthenticationType::OrSymbol, + authentication_type: + FinchAPI::Models::Sandbox::Connections::AccountUpdateResponse::AuthenticationType::OrSymbol, company_id: String, products: T::Array[String], provider_id: String, connection_id: String - ) - .returns(T.attached_class) + ).returns(T.attached_class) end def self.new( # [DEPRECATED] Use `connection_id` to associate a connection with an access token @@ -52,27 +59,35 @@ module FinchAPI provider_id:, # The ID of the new connection connection_id: nil - ); end + ) + end + sig do - override - .returns( - { - account_id: String, - authentication_type: FinchAPI::Models::Sandbox::Connections::AccountUpdateResponse::AuthenticationType::TaggedSymbol, - company_id: String, - products: T::Array[String], - provider_id: String, - connection_id: String - } - ) + override.returns( + { + account_id: String, + authentication_type: + FinchAPI::Models::Sandbox::Connections::AccountUpdateResponse::AuthenticationType::TaggedSymbol, + company_id: String, + products: T::Array[String], + provider_id: String, + connection_id: String + } + ) + end + def to_hash end - def to_hash; end module AuthenticationType extend FinchAPI::Internal::Type::Enum TaggedSymbol = - T.type_alias { T.all(Symbol, FinchAPI::Models::Sandbox::Connections::AccountUpdateResponse::AuthenticationType) } + T.type_alias do + T.all( + Symbol, + FinchAPI::Models::Sandbox::Connections::AccountUpdateResponse::AuthenticationType + ) + end OrSymbol = T.type_alias { T.any(Symbol, String) } CREDENTIAL = @@ -97,12 +112,14 @@ module FinchAPI ) sig do - override - .returns( - T::Array[FinchAPI::Models::Sandbox::Connections::AccountUpdateResponse::AuthenticationType::TaggedSymbol] - ) + override.returns( + T::Array[ + FinchAPI::Models::Sandbox::Connections::AccountUpdateResponse::AuthenticationType::TaggedSymbol + ] + ) + end + def self.values end - def self.values; end end end end diff --git a/rbi/finch_api/models/sandbox/directory_create_params.rbi b/rbi/finch_api/models/sandbox/directory_create_params.rbi index 5cc54de6..542a66bc 100644 --- a/rbi/finch_api/models/sandbox/directory_create_params.rbi +++ b/rbi/finch_api/models/sandbox/directory_create_params.rbi @@ -7,44 +7,56 @@ module FinchAPI extend FinchAPI::Internal::Type::RequestParameters::Converter include FinchAPI::Internal::Type::RequestParameters + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + # 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])) } + sig do + returns( + T.nilable(T::Array[FinchAPI::Sandbox::DirectoryCreateParams::Body]) + ) + end attr_reader :body sig do params( - body: T::Array[T.any(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body, FinchAPI::Internal::AnyHash)] - ) - .void + body: + T::Array[FinchAPI::Sandbox::DirectoryCreateParams::Body::OrHash] + ).void end attr_writer :body sig do params( - body: T::Array[T.any(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body, FinchAPI::Internal::AnyHash)], - request_options: T.any(FinchAPI::RequestOptions, FinchAPI::Internal::AnyHash) - ) - .returns(T.attached_class) + body: + T::Array[FinchAPI::Sandbox::DirectoryCreateParams::Body::OrHash], + request_options: FinchAPI::RequestOptions::OrHash + ).returns(T.attached_class) end def self.new( # Array of individuals to create. Takes all combined fields from `/individual` and # `/employment` endpoints. All fields are optional. body: nil, request_options: {} - ); end + ) + end + sig do - override - .returns( - { - body: T::Array[FinchAPI::Models::Sandbox::DirectoryCreateParams::Body], - request_options: FinchAPI::RequestOptions - } - ) + override.returns( + { + body: T::Array[FinchAPI::Sandbox::DirectoryCreateParams::Body], + request_options: FinchAPI::RequestOptions + } + ) + end + def to_hash end - def to_hash; end class Body < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + # Worker's compensation classification code for this employee sig { returns(T.nilable(String)) } attr_accessor :class_code @@ -52,53 +64,87 @@ module FinchAPI # 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])) } + sig do + returns( + T.nilable( + T::Array[ + FinchAPI::Sandbox::DirectoryCreateParams::Body::CustomField + ] + ) + ) + end attr_reader :custom_fields sig do params( - custom_fields: T::Array[T.any(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::CustomField, FinchAPI::Internal::AnyHash)] - ) - .void + custom_fields: + T::Array[ + FinchAPI::Sandbox::DirectoryCreateParams::Body::CustomField::OrHash + ] + ).void end attr_writer :custom_fields # The department object. - sig { returns(T.nilable(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Department)) } + sig do + returns( + T.nilable( + FinchAPI::Sandbox::DirectoryCreateParams::Body::Department + ) + ) + end attr_reader :department sig do params( - department: T.nilable( - T.any(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Department, FinchAPI::Internal::AnyHash) - ) - ) - .void + department: + T.nilable( + FinchAPI::Sandbox::DirectoryCreateParams::Body::Department::OrHash + ) + ).void end attr_writer :department sig { returns(T.nilable(String)) } attr_accessor :dob - sig { returns(T.nilable(T::Array[FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Email])) } + sig do + returns( + T.nilable( + T::Array[FinchAPI::Sandbox::DirectoryCreateParams::Body::Email] + ) + ) + end attr_accessor :emails # The employment object. - sig { returns(T.nilable(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment)) } + sig do + returns( + T.nilable( + FinchAPI::Sandbox::DirectoryCreateParams::Body::Employment + ) + ) + end attr_reader :employment sig do params( - employment: T.nilable( - T.any(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment, FinchAPI::Internal::AnyHash) - ) - ) - .void + employment: + T.nilable( + FinchAPI::Sandbox::DirectoryCreateParams::Body::Employment::OrHash + ) + ).void end attr_writer :employment # The detailed employment status of the individual. - sig { returns(T.nilable(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::EmploymentStatus::OrSymbol)) } + sig do + returns( + T.nilable( + FinchAPI::Sandbox::DirectoryCreateParams::Body::EmploymentStatus::OrSymbol + ) + ) + end attr_accessor :employment_status # Social Security Number of the individual in **encrypted** format. This field is @@ -111,7 +157,13 @@ module FinchAPI attr_accessor :end_date # The EEOC-defined ethnicity of the individual. - sig { returns(T.nilable(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Ethnicity::OrSymbol)) } + sig do + returns( + T.nilable( + FinchAPI::Sandbox::DirectoryCreateParams::Body::Ethnicity::OrSymbol + ) + ) + end attr_accessor :ethnicity # The legal first name of the individual. @@ -119,20 +171,26 @@ module FinchAPI attr_accessor :first_name # The gender of the individual. - sig { returns(T.nilable(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Gender::OrSymbol)) } + sig do + returns( + T.nilable( + FinchAPI::Sandbox::DirectoryCreateParams::Body::Gender::OrSymbol + ) + ) + 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)) } + sig { returns(T.nilable(FinchAPI::Income)) } attr_reader :income - sig { params(income: T.nilable(T.any(FinchAPI::Models::Income, FinchAPI::Internal::AnyHash))).void } + sig { params(income: T.nilable(FinchAPI::Income::OrHash)).void } attr_writer :income # The array of income history. - sig { returns(T.nilable(T::Array[T.nilable(FinchAPI::Models::Income)])) } + sig { returns(T.nilable(T::Array[T.nilable(FinchAPI::Income)])) } attr_accessor :income_history # `true` if the individual an an active employee or contractor at the company. @@ -146,23 +204,27 @@ module FinchAPI sig { returns(T.nilable(String)) } attr_accessor :latest_rehire_date - sig { returns(T.nilable(FinchAPI::Models::Location)) } + sig { returns(T.nilable(FinchAPI::Location)) } attr_reader :location - sig { params(location: T.nilable(T.any(FinchAPI::Models::Location, FinchAPI::Internal::AnyHash))).void } + sig { params(location: T.nilable(FinchAPI::Location::OrHash)).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)) } + sig do + returns( + T.nilable(FinchAPI::Sandbox::DirectoryCreateParams::Body::Manager) + ) + end attr_reader :manager sig do params( - manager: T.nilable( - T.any(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Manager, FinchAPI::Internal::AnyHash) - ) - ) - .void + manager: + T.nilable( + FinchAPI::Sandbox::DirectoryCreateParams::Body::Manager::OrHash + ) + ).void end attr_writer :manager @@ -172,7 +234,13 @@ module FinchAPI sig do returns( - T.nilable(T::Array[T.nilable(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::PhoneNumber)]) + T.nilable( + T::Array[ + T.nilable( + FinchAPI::Sandbox::DirectoryCreateParams::Body::PhoneNumber + ) + ] + ) ) end attr_accessor :phone_numbers @@ -181,10 +249,10 @@ module FinchAPI sig { returns(T.nilable(String)) } attr_accessor :preferred_name - sig { returns(T.nilable(FinchAPI::Models::Location)) } + sig { returns(T.nilable(FinchAPI::Location)) } attr_reader :residence - sig { params(residence: T.nilable(T.any(FinchAPI::Models::Location, FinchAPI::Internal::AnyHash))).void } + sig { params(residence: T.nilable(FinchAPI::Location::OrHash)).void } attr_writer :residence # The source system's unique employment identifier for this individual @@ -211,48 +279,67 @@ module FinchAPI sig do params( class_code: T.nilable(String), - custom_fields: T::Array[T.any(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::CustomField, FinchAPI::Internal::AnyHash)], - department: T.nilable( - T.any(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Department, FinchAPI::Internal::AnyHash) - ), + custom_fields: + T::Array[ + FinchAPI::Sandbox::DirectoryCreateParams::Body::CustomField::OrHash + ], + department: + T.nilable( + FinchAPI::Sandbox::DirectoryCreateParams::Body::Department::OrHash + ), dob: T.nilable(String), - emails: T.nilable( - T::Array[T.any(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Email, FinchAPI::Internal::AnyHash)] - ), - employment: T.nilable( - T.any(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment, FinchAPI::Internal::AnyHash) - ), - employment_status: T.nilable(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::EmploymentStatus::OrSymbol), + emails: + T.nilable( + T::Array[ + FinchAPI::Sandbox::DirectoryCreateParams::Body::Email::OrHash + ] + ), + employment: + T.nilable( + FinchAPI::Sandbox::DirectoryCreateParams::Body::Employment::OrHash + ), + employment_status: + T.nilable( + FinchAPI::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), + ethnicity: + T.nilable( + FinchAPI::Sandbox::DirectoryCreateParams::Body::Ethnicity::OrSymbol + ), first_name: T.nilable(String), - gender: T.nilable(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Gender::OrSymbol), - income: T.nilable(T.any(FinchAPI::Models::Income, FinchAPI::Internal::AnyHash)), - income_history: T.nilable(T::Array[T.nilable(T.any(FinchAPI::Models::Income, FinchAPI::Internal::AnyHash))]), + gender: + T.nilable( + FinchAPI::Sandbox::DirectoryCreateParams::Body::Gender::OrSymbol + ), + income: T.nilable(FinchAPI::Income::OrHash), + income_history: + T.nilable(T::Array[T.nilable(FinchAPI::Income::OrHash)]), 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::Internal::AnyHash)), - manager: T.nilable( - T.any(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Manager, FinchAPI::Internal::AnyHash) - ), + location: T.nilable(FinchAPI::Location::OrHash), + manager: + T.nilable( + FinchAPI::Sandbox::DirectoryCreateParams::Body::Manager::OrHash + ), middle_name: T.nilable(String), - phone_numbers: T.nilable( - T::Array[ - T.nilable( - T.any(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::PhoneNumber, FinchAPI::Internal::AnyHash) - ) - ] - ), + phone_numbers: + T.nilable( + T::Array[ + T.nilable( + FinchAPI::Sandbox::DirectoryCreateParams::Body::PhoneNumber::OrHash + ) + ] + ), preferred_name: T.nilable(String), - residence: T.nilable(T.any(FinchAPI::Models::Location, FinchAPI::Internal::AnyHash)), + residence: T.nilable(FinchAPI::Location::OrHash), source_id: String, ssn: T.nilable(String), start_date: T.nilable(String), title: T.nilable(String) - ) - .returns(T.attached_class) + ).returns(T.attached_class) end def self.new( # Worker's compensation classification code for this employee @@ -310,44 +397,83 @@ module FinchAPI start_date: nil, # The current title of the individual. title: nil - ); end + ) + end + sig do - override - .returns( - { - class_code: T.nilable(String), - custom_fields: T::Array[FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::CustomField], - department: T.nilable(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Department), - 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(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_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), - 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), - source_id: String, - ssn: T.nilable(String), - start_date: T.nilable(String), - title: T.nilable(String) - } - ) + override.returns( + { + class_code: T.nilable(String), + custom_fields: + T::Array[ + FinchAPI::Sandbox::DirectoryCreateParams::Body::CustomField + ], + department: + T.nilable( + FinchAPI::Sandbox::DirectoryCreateParams::Body::Department + ), + dob: T.nilable(String), + emails: + T.nilable( + T::Array[ + FinchAPI::Sandbox::DirectoryCreateParams::Body::Email + ] + ), + employment: + T.nilable( + FinchAPI::Sandbox::DirectoryCreateParams::Body::Employment + ), + employment_status: + T.nilable( + FinchAPI::Sandbox::DirectoryCreateParams::Body::EmploymentStatus::OrSymbol + ), + encrypted_ssn: T.nilable(String), + end_date: T.nilable(String), + ethnicity: + T.nilable( + FinchAPI::Sandbox::DirectoryCreateParams::Body::Ethnicity::OrSymbol + ), + first_name: T.nilable(String), + gender: + T.nilable( + FinchAPI::Sandbox::DirectoryCreateParams::Body::Gender::OrSymbol + ), + income: T.nilable(FinchAPI::Income), + income_history: + T.nilable(T::Array[T.nilable(FinchAPI::Income)]), + is_active: T.nilable(T::Boolean), + last_name: T.nilable(String), + latest_rehire_date: T.nilable(String), + location: T.nilable(FinchAPI::Location), + manager: + T.nilable( + FinchAPI::Sandbox::DirectoryCreateParams::Body::Manager + ), + middle_name: T.nilable(String), + phone_numbers: + T.nilable( + T::Array[ + T.nilable( + FinchAPI::Sandbox::DirectoryCreateParams::Body::PhoneNumber + ) + ] + ), + preferred_name: T.nilable(String), + residence: T.nilable(FinchAPI::Location), + source_id: String, + ssn: T.nilable(String), + start_date: T.nilable(String), + title: T.nilable(String) + } + ) + end + def to_hash end - def to_hash; end class CustomField < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + sig { returns(T.nilable(String)) } attr_accessor :name @@ -357,14 +483,25 @@ module FinchAPI 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); end + sig do + params(name: T.nilable(String), value: T.anything).returns( + T.attached_class + ) + end + def self.new(name: nil, value: nil) + end - sig { override.returns({name: T.nilable(String), value: T.anything}) } - def to_hash; end + sig do + override.returns({ name: T.nilable(String), value: T.anything }) + end + def to_hash + end end class Department < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + # The name of the department associated with the individual. sig { returns(T.nilable(String)) } attr_accessor :name @@ -374,74 +511,131 @@ module FinchAPI def self.new( # The name of the department associated with the individual. name: nil - ); end - sig { override.returns({name: T.nilable(String)}) } - def to_hash; end + ) + end + + sig { override.returns({ name: T.nilable(String) }) } + def to_hash + end end class Email < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + sig { returns(T.nilable(String)) } attr_reader :data sig { params(data: String).void } attr_writer :data - sig { returns(T.nilable(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Email::Type::OrSymbol)) } + sig do + returns( + T.nilable( + FinchAPI::Sandbox::DirectoryCreateParams::Body::Email::Type::OrSymbol + ) + ) + end attr_accessor :type sig do params( data: String, - type: T.nilable(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Email::Type::OrSymbol) - ) - .returns(T.attached_class) + type: + T.nilable( + FinchAPI::Sandbox::DirectoryCreateParams::Body::Email::Type::OrSymbol + ) + ).returns(T.attached_class) + end + def self.new(data: nil, type: nil) end - def self.new(data: nil, type: nil); end sig do - override - .returns( - {data: String, type: T.nilable(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Email::Type::OrSymbol)} - ) + override.returns( + { + data: String, + type: + T.nilable( + FinchAPI::Sandbox::DirectoryCreateParams::Body::Email::Type::OrSymbol + ) + } + ) + end + def to_hash end - def to_hash; end module Type extend FinchAPI::Internal::Type::Enum TaggedSymbol = - T.type_alias { T.all(Symbol, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Email::Type) } + T.type_alias do + T.all( + Symbol, + FinchAPI::Sandbox::DirectoryCreateParams::Body::Email::Type + ) + end OrSymbol = T.type_alias { T.any(Symbol, String) } - WORK = T.let(:work, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Email::Type::TaggedSymbol) + WORK = + T.let( + :work, + FinchAPI::Sandbox::DirectoryCreateParams::Body::Email::Type::TaggedSymbol + ) PERSONAL = - T.let(:personal, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Email::Type::TaggedSymbol) + T.let( + :personal, + FinchAPI::Sandbox::DirectoryCreateParams::Body::Email::Type::TaggedSymbol + ) sig do - override - .returns(T::Array[FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Email::Type::TaggedSymbol]) + override.returns( + T::Array[ + FinchAPI::Sandbox::DirectoryCreateParams::Body::Email::Type::TaggedSymbol + ] + ) + end + def self.values end - def self.values; end end end class Employment < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + # 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)) } + sig do + returns( + T.nilable( + FinchAPI::Sandbox::DirectoryCreateParams::Body::Employment::Subtype::OrSymbol + ) + ) + end attr_accessor :subtype # The main employment type of the individual. - sig { returns(T.nilable(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment::Type::OrSymbol)) } + sig do + returns( + T.nilable( + FinchAPI::Sandbox::DirectoryCreateParams::Body::Employment::Type::OrSymbol + ) + ) + end attr_accessor :type # The employment object. 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) + subtype: + T.nilable( + FinchAPI::Sandbox::DirectoryCreateParams::Body::Employment::Subtype::OrSymbol + ), + type: + T.nilable( + FinchAPI::Sandbox::DirectoryCreateParams::Body::Employment::Type::OrSymbol + ) + ).returns(T.attached_class) end def self.new( # The secondary employment type of the individual. Options: `full_time`, @@ -449,17 +643,25 @@ module FinchAPI subtype: nil, # The main employment type of the individual. type: nil - ); end + ) + end + 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) - } - ) + override.returns( + { + subtype: + T.nilable( + FinchAPI::Sandbox::DirectoryCreateParams::Body::Employment::Subtype::OrSymbol + ), + type: + T.nilable( + FinchAPI::Sandbox::DirectoryCreateParams::Body::Employment::Type::OrSymbol + ) + } + ) + end + def to_hash end - def to_hash; end # The secondary employment type of the individual. Options: `full_time`, # `part_time`, `intern`, `temp`, `seasonal` and `individual_contractor`. @@ -467,41 +669,54 @@ module FinchAPI extend FinchAPI::Internal::Type::Enum TaggedSymbol = - T.type_alias { T.all(Symbol, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment::Subtype) } + T.type_alias do + T.all( + Symbol, + FinchAPI::Sandbox::DirectoryCreateParams::Body::Employment::Subtype + ) + end OrSymbol = T.type_alias { T.any(Symbol, String) } FULL_TIME = T.let( :full_time, - FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment::Subtype::TaggedSymbol + FinchAPI::Sandbox::DirectoryCreateParams::Body::Employment::Subtype::TaggedSymbol ) INTERN = - T.let(:intern, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment::Subtype::TaggedSymbol) + T.let( + :intern, + FinchAPI::Sandbox::DirectoryCreateParams::Body::Employment::Subtype::TaggedSymbol + ) PART_TIME = T.let( :part_time, - FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment::Subtype::TaggedSymbol + FinchAPI::Sandbox::DirectoryCreateParams::Body::Employment::Subtype::TaggedSymbol ) TEMP = - T.let(:temp, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment::Subtype::TaggedSymbol) + T.let( + :temp, + FinchAPI::Sandbox::DirectoryCreateParams::Body::Employment::Subtype::TaggedSymbol + ) SEASONAL = T.let( :seasonal, - FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment::Subtype::TaggedSymbol + FinchAPI::Sandbox::DirectoryCreateParams::Body::Employment::Subtype::TaggedSymbol ) INDIVIDUAL_CONTRACTOR = T.let( :individual_contractor, - FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment::Subtype::TaggedSymbol + FinchAPI::Sandbox::DirectoryCreateParams::Body::Employment::Subtype::TaggedSymbol ) sig do - override - .returns( - T::Array[FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment::Subtype::TaggedSymbol] - ) + override.returns( + T::Array[ + FinchAPI::Sandbox::DirectoryCreateParams::Body::Employment::Subtype::TaggedSymbol + ] + ) + end + def self.values end - def self.values; end end # The main employment type of the individual. @@ -509,19 +724,34 @@ module FinchAPI extend FinchAPI::Internal::Type::Enum TaggedSymbol = - T.type_alias { T.all(Symbol, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment::Type) } + T.type_alias do + T.all( + Symbol, + FinchAPI::Sandbox::DirectoryCreateParams::Body::Employment::Type + ) + end OrSymbol = T.type_alias { T.any(Symbol, String) } EMPLOYEE = - T.let(:employee, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment::Type::TaggedSymbol) + T.let( + :employee, + FinchAPI::Sandbox::DirectoryCreateParams::Body::Employment::Type::TaggedSymbol + ) CONTRACTOR = - T.let(:contractor, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment::Type::TaggedSymbol) + T.let( + :contractor, + FinchAPI::Sandbox::DirectoryCreateParams::Body::Employment::Type::TaggedSymbol + ) sig do - override - .returns(T::Array[FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment::Type::TaggedSymbol]) + override.returns( + T::Array[ + FinchAPI::Sandbox::DirectoryCreateParams::Body::Employment::Type::TaggedSymbol + ] + ) + end + def self.values end - def self.values; end end end @@ -530,29 +760,59 @@ module FinchAPI extend FinchAPI::Internal::Type::Enum TaggedSymbol = - T.type_alias { T.all(Symbol, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::EmploymentStatus) } + T.type_alias do + T.all( + Symbol, + FinchAPI::Sandbox::DirectoryCreateParams::Body::EmploymentStatus + ) + end OrSymbol = T.type_alias { T.any(Symbol, String) } ACTIVE = - T.let(:active, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::EmploymentStatus::TaggedSymbol) + T.let( + :active, + FinchAPI::Sandbox::DirectoryCreateParams::Body::EmploymentStatus::TaggedSymbol + ) DECEASED = - T.let(:deceased, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::EmploymentStatus::TaggedSymbol) + T.let( + :deceased, + FinchAPI::Sandbox::DirectoryCreateParams::Body::EmploymentStatus::TaggedSymbol + ) LEAVE = - T.let(:leave, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::EmploymentStatus::TaggedSymbol) + T.let( + :leave, + FinchAPI::Sandbox::DirectoryCreateParams::Body::EmploymentStatus::TaggedSymbol + ) ONBOARDING = - T.let(:onboarding, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::EmploymentStatus::TaggedSymbol) + T.let( + :onboarding, + FinchAPI::Sandbox::DirectoryCreateParams::Body::EmploymentStatus::TaggedSymbol + ) PREHIRE = - T.let(:prehire, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::EmploymentStatus::TaggedSymbol) + T.let( + :prehire, + FinchAPI::Sandbox::DirectoryCreateParams::Body::EmploymentStatus::TaggedSymbol + ) RETIRED = - T.let(:retired, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::EmploymentStatus::TaggedSymbol) + T.let( + :retired, + FinchAPI::Sandbox::DirectoryCreateParams::Body::EmploymentStatus::TaggedSymbol + ) TERMINATED = - T.let(:terminated, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::EmploymentStatus::TaggedSymbol) + T.let( + :terminated, + FinchAPI::Sandbox::DirectoryCreateParams::Body::EmploymentStatus::TaggedSymbol + ) sig do - override - .returns(T::Array[FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::EmploymentStatus::TaggedSymbol]) + override.returns( + T::Array[ + FinchAPI::Sandbox::DirectoryCreateParams::Body::EmploymentStatus::TaggedSymbol + ] + ) + end + def self.values end - def self.values; end end # The EEOC-defined ethnicity of the individual. @@ -560,43 +820,64 @@ module FinchAPI extend FinchAPI::Internal::Type::Enum TaggedSymbol = - T.type_alias { T.all(Symbol, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Ethnicity) } + T.type_alias do + T.all( + Symbol, + FinchAPI::Sandbox::DirectoryCreateParams::Body::Ethnicity + ) + end OrSymbol = T.type_alias { T.any(Symbol, String) } - ASIAN = T.let(:asian, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Ethnicity::TaggedSymbol) - WHITE = T.let(:white, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Ethnicity::TaggedSymbol) + ASIAN = + T.let( + :asian, + FinchAPI::Sandbox::DirectoryCreateParams::Body::Ethnicity::TaggedSymbol + ) + WHITE = + T.let( + :white, + FinchAPI::Sandbox::DirectoryCreateParams::Body::Ethnicity::TaggedSymbol + ) BLACK_OR_AFRICAN_AMERICAN = T.let( :black_or_african_american, - FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Ethnicity::TaggedSymbol + FinchAPI::Sandbox::DirectoryCreateParams::Body::Ethnicity::TaggedSymbol ) NATIVE_HAWAIIAN_OR_PACIFIC_ISLANDER = T.let( :native_hawaiian_or_pacific_islander, - FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Ethnicity::TaggedSymbol + FinchAPI::Sandbox::DirectoryCreateParams::Body::Ethnicity::TaggedSymbol ) AMERICAN_INDIAN_OR_ALASKA_NATIVE = T.let( :american_indian_or_alaska_native, - FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Ethnicity::TaggedSymbol + FinchAPI::Sandbox::DirectoryCreateParams::Body::Ethnicity::TaggedSymbol ) HISPANIC_OR_LATINO = T.let( :hispanic_or_latino, - FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Ethnicity::TaggedSymbol + FinchAPI::Sandbox::DirectoryCreateParams::Body::Ethnicity::TaggedSymbol ) TWO_OR_MORE_RACES = - T.let(:two_or_more_races, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Ethnicity::TaggedSymbol) + T.let( + :two_or_more_races, + FinchAPI::Sandbox::DirectoryCreateParams::Body::Ethnicity::TaggedSymbol + ) DECLINE_TO_SPECIFY = T.let( :decline_to_specify, - FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Ethnicity::TaggedSymbol + FinchAPI::Sandbox::DirectoryCreateParams::Body::Ethnicity::TaggedSymbol ) sig do - override.returns(T::Array[FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Ethnicity::TaggedSymbol]) + override.returns( + T::Array[ + FinchAPI::Sandbox::DirectoryCreateParams::Body::Ethnicity::TaggedSymbol + ] + ) + end + def self.values end - def self.values; end end # The gender of the individual. @@ -604,20 +885,50 @@ module FinchAPI extend FinchAPI::Internal::Type::Enum TaggedSymbol = - T.type_alias { T.all(Symbol, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Gender) } + T.type_alias do + T.all( + Symbol, + FinchAPI::Sandbox::DirectoryCreateParams::Body::Gender + ) + end OrSymbol = T.type_alias { T.any(Symbol, String) } - 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) + FEMALE = + T.let( + :female, + FinchAPI::Sandbox::DirectoryCreateParams::Body::Gender::TaggedSymbol + ) + MALE = + T.let( + :male, + FinchAPI::Sandbox::DirectoryCreateParams::Body::Gender::TaggedSymbol + ) + OTHER = + T.let( + :other, + FinchAPI::Sandbox::DirectoryCreateParams::Body::Gender::TaggedSymbol + ) DECLINE_TO_SPECIFY = - T.let(:decline_to_specify, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Gender::TaggedSymbol) + T.let( + :decline_to_specify, + FinchAPI::Sandbox::DirectoryCreateParams::Body::Gender::TaggedSymbol + ) - sig { override.returns(T::Array[FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Gender::TaggedSymbol]) } - def self.values; end + sig do + override.returns( + T::Array[ + FinchAPI::Sandbox::DirectoryCreateParams::Body::Gender::TaggedSymbol + ] + ) + end + def self.values + end end class Manager < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + # A stable Finch `id` (UUID v4) for an individual in the company. sig { returns(T.nilable(String)) } attr_reader :id @@ -630,55 +941,88 @@ module FinchAPI def self.new( # A stable Finch `id` (UUID v4) for an individual in the company. id: nil - ); end - sig { override.returns({id: String}) } - def to_hash; end + ) + end + + sig { override.returns({ id: String }) } + def to_hash + end end class PhoneNumber < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + sig { returns(T.nilable(String)) } attr_accessor :data - sig { returns(T.nilable(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::PhoneNumber::Type::OrSymbol)) } + sig do + returns( + T.nilable( + FinchAPI::Sandbox::DirectoryCreateParams::Body::PhoneNumber::Type::OrSymbol + ) + ) + end attr_accessor :type sig do params( data: T.nilable(String), - type: T.nilable(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::PhoneNumber::Type::OrSymbol) - ) - .returns(T.attached_class) + type: + T.nilable( + FinchAPI::Sandbox::DirectoryCreateParams::Body::PhoneNumber::Type::OrSymbol + ) + ).returns(T.attached_class) + end + def self.new(data: nil, type: nil) end - def self.new(data: nil, type: nil); end sig do - override - .returns( - { - data: T.nilable(String), - type: T.nilable(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::PhoneNumber::Type::OrSymbol) - } - ) + override.returns( + { + data: T.nilable(String), + type: + T.nilable( + FinchAPI::Sandbox::DirectoryCreateParams::Body::PhoneNumber::Type::OrSymbol + ) + } + ) + end + def to_hash end - def to_hash; end module Type extend FinchAPI::Internal::Type::Enum TaggedSymbol = - T.type_alias { T.all(Symbol, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::PhoneNumber::Type) } + T.type_alias do + T.all( + Symbol, + FinchAPI::Sandbox::DirectoryCreateParams::Body::PhoneNumber::Type + ) + end OrSymbol = T.type_alias { T.any(Symbol, String) } WORK = - T.let(:work, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::PhoneNumber::Type::TaggedSymbol) + T.let( + :work, + FinchAPI::Sandbox::DirectoryCreateParams::Body::PhoneNumber::Type::TaggedSymbol + ) PERSONAL = - T.let(:personal, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::PhoneNumber::Type::TaggedSymbol) + T.let( + :personal, + FinchAPI::Sandbox::DirectoryCreateParams::Body::PhoneNumber::Type::TaggedSymbol + ) sig do - override - .returns(T::Array[FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::PhoneNumber::Type::TaggedSymbol]) + override.returns( + T::Array[ + FinchAPI::Sandbox::DirectoryCreateParams::Body::PhoneNumber::Type::TaggedSymbol + ] + ) + end + def self.values end - def self.values; end end end end diff --git a/rbi/finch_api/models/sandbox/employment_update_params.rbi b/rbi/finch_api/models/sandbox/employment_update_params.rbi index d314aef3..bfd932a7 100644 --- a/rbi/finch_api/models/sandbox/employment_update_params.rbi +++ b/rbi/finch_api/models/sandbox/employment_update_params.rbi @@ -7,6 +7,9 @@ module FinchAPI extend FinchAPI::Internal::Type::RequestParameters::Converter include FinchAPI::Internal::Type::RequestParameters + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + # Worker's compensation classification code for this employee sig { returns(T.nilable(String)) } attr_accessor :class_code @@ -14,47 +17,69 @@ module FinchAPI # 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])) } + sig do + returns( + T.nilable( + T::Array[FinchAPI::Sandbox::EmploymentUpdateParams::CustomField] + ) + ) + end attr_reader :custom_fields sig do params( - custom_fields: T::Array[T.any(FinchAPI::Models::Sandbox::EmploymentUpdateParams::CustomField, FinchAPI::Internal::AnyHash)] - ) - .void + custom_fields: + T::Array[ + FinchAPI::Sandbox::EmploymentUpdateParams::CustomField::OrHash + ] + ).void end attr_writer :custom_fields # The department object. - sig { returns(T.nilable(FinchAPI::Models::Sandbox::EmploymentUpdateParams::Department)) } + sig do + returns( + T.nilable(FinchAPI::Sandbox::EmploymentUpdateParams::Department) + ) + end attr_reader :department sig do params( - department: T.nilable( - T.any(FinchAPI::Models::Sandbox::EmploymentUpdateParams::Department, FinchAPI::Internal::AnyHash) - ) - ) - .void + department: + T.nilable( + FinchAPI::Sandbox::EmploymentUpdateParams::Department::OrHash + ) + ).void end attr_writer :department # The employment object. - sig { returns(T.nilable(FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment)) } + sig do + returns( + T.nilable(FinchAPI::Sandbox::EmploymentUpdateParams::Employment) + ) + end attr_reader :employment sig do params( - employment: T.nilable( - T.any(FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment, FinchAPI::Internal::AnyHash) - ) - ) - .void + employment: + T.nilable( + FinchAPI::Sandbox::EmploymentUpdateParams::Employment::OrHash + ) + ).void end attr_writer :employment # The detailed employment status of the individual. - sig { returns(T.nilable(FinchAPI::Models::Sandbox::EmploymentUpdateParams::EmploymentStatus::OrSymbol)) } + sig do + returns( + T.nilable( + FinchAPI::Sandbox::EmploymentUpdateParams::EmploymentStatus::OrSymbol + ) + ) + end attr_accessor :employment_status sig { returns(T.nilable(String)) } @@ -67,14 +92,14 @@ module FinchAPI # 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)) } + sig { returns(T.nilable(FinchAPI::Income)) } attr_reader :income - sig { params(income: T.nilable(T.any(FinchAPI::Models::Income, FinchAPI::Internal::AnyHash))).void } + sig { params(income: T.nilable(FinchAPI::Income::OrHash)).void } attr_writer :income # The array of income history. - sig { returns(T.nilable(T::Array[T.nilable(FinchAPI::Models::Income)])) } + sig { returns(T.nilable(T::Array[T.nilable(FinchAPI::Income)])) } attr_accessor :income_history # `true` if the individual an an active employee or contractor at the company. @@ -88,21 +113,25 @@ module FinchAPI sig { returns(T.nilable(String)) } attr_accessor :latest_rehire_date - sig { returns(T.nilable(FinchAPI::Models::Location)) } + sig { returns(T.nilable(FinchAPI::Location)) } attr_reader :location - sig { params(location: T.nilable(T.any(FinchAPI::Models::Location, FinchAPI::Internal::AnyHash))).void } + sig { params(location: T.nilable(FinchAPI::Location::OrHash)).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)) } + sig do + returns(T.nilable(FinchAPI::Sandbox::EmploymentUpdateParams::Manager)) + end attr_reader :manager sig do params( - manager: T.nilable(T.any(FinchAPI::Models::Sandbox::EmploymentUpdateParams::Manager, FinchAPI::Internal::AnyHash)) - ) - .void + manager: + T.nilable( + FinchAPI::Sandbox::EmploymentUpdateParams::Manager::OrHash + ) + ).void end attr_writer :manager @@ -127,30 +156,41 @@ module FinchAPI sig do params( class_code: T.nilable(String), - custom_fields: T::Array[T.any(FinchAPI::Models::Sandbox::EmploymentUpdateParams::CustomField, FinchAPI::Internal::AnyHash)], - department: T.nilable( - T.any(FinchAPI::Models::Sandbox::EmploymentUpdateParams::Department, FinchAPI::Internal::AnyHash) - ), - employment: T.nilable( - T.any(FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment, FinchAPI::Internal::AnyHash) - ), - employment_status: T.nilable(FinchAPI::Models::Sandbox::EmploymentUpdateParams::EmploymentStatus::OrSymbol), + custom_fields: + T::Array[ + FinchAPI::Sandbox::EmploymentUpdateParams::CustomField::OrHash + ], + department: + T.nilable( + FinchAPI::Sandbox::EmploymentUpdateParams::Department::OrHash + ), + employment: + T.nilable( + FinchAPI::Sandbox::EmploymentUpdateParams::Employment::OrHash + ), + employment_status: + T.nilable( + FinchAPI::Sandbox::EmploymentUpdateParams::EmploymentStatus::OrSymbol + ), end_date: T.nilable(String), first_name: T.nilable(String), - income: T.nilable(T.any(FinchAPI::Models::Income, FinchAPI::Internal::AnyHash)), - income_history: T.nilable(T::Array[T.nilable(T.any(FinchAPI::Models::Income, FinchAPI::Internal::AnyHash))]), + income: T.nilable(FinchAPI::Income::OrHash), + income_history: + T.nilable(T::Array[T.nilable(FinchAPI::Income::OrHash)]), 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::Internal::AnyHash)), - manager: T.nilable(T.any(FinchAPI::Models::Sandbox::EmploymentUpdateParams::Manager, FinchAPI::Internal::AnyHash)), + location: T.nilable(FinchAPI::Location::OrHash), + manager: + T.nilable( + FinchAPI::Sandbox::EmploymentUpdateParams::Manager::OrHash + ), middle_name: T.nilable(String), source_id: String, start_date: T.nilable(String), title: T.nilable(String), - request_options: T.any(FinchAPI::RequestOptions, FinchAPI::Internal::AnyHash) - ) - .returns(T.attached_class) + request_options: FinchAPI::RequestOptions::OrHash + ).returns(T.attached_class) end def self.new( # Worker's compensation classification code for this employee @@ -190,36 +230,54 @@ module FinchAPI # The current title of the individual. title: nil, request_options: {} - ); end + ) + end + sig do - override - .returns( - { - 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), - 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)]), - 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), - middle_name: T.nilable(String), - source_id: String, - start_date: T.nilable(String), - title: T.nilable(String), - request_options: FinchAPI::RequestOptions - } - ) + override.returns( + { + class_code: T.nilable(String), + custom_fields: + T::Array[ + FinchAPI::Sandbox::EmploymentUpdateParams::CustomField + ], + department: + T.nilable( + FinchAPI::Sandbox::EmploymentUpdateParams::Department + ), + employment: + T.nilable( + FinchAPI::Sandbox::EmploymentUpdateParams::Employment + ), + employment_status: + T.nilable( + FinchAPI::Sandbox::EmploymentUpdateParams::EmploymentStatus::OrSymbol + ), + end_date: T.nilable(String), + first_name: T.nilable(String), + income: T.nilable(FinchAPI::Income), + income_history: T.nilable(T::Array[T.nilable(FinchAPI::Income)]), + is_active: T.nilable(T::Boolean), + last_name: T.nilable(String), + latest_rehire_date: T.nilable(String), + location: T.nilable(FinchAPI::Location), + manager: + T.nilable(FinchAPI::Sandbox::EmploymentUpdateParams::Manager), + middle_name: T.nilable(String), + source_id: String, + start_date: T.nilable(String), + title: T.nilable(String), + request_options: FinchAPI::RequestOptions + } + ) + end + def to_hash end - def to_hash; end class CustomField < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + sig { returns(T.nilable(String)) } attr_accessor :name @@ -229,14 +287,25 @@ module FinchAPI 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); end + sig do + params(name: T.nilable(String), value: T.anything).returns( + T.attached_class + ) + end + def self.new(name: nil, value: nil) + end - sig { override.returns({name: T.nilable(String), value: T.anything}) } - def to_hash; end + sig do + override.returns({ name: T.nilable(String), value: T.anything }) + end + def to_hash + end end class Department < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + # The name of the department associated with the individual. sig { returns(T.nilable(String)) } attr_accessor :name @@ -246,28 +315,51 @@ module FinchAPI def self.new( # The name of the department associated with the individual. name: nil - ); end - sig { override.returns({name: T.nilable(String)}) } - def to_hash; end + ) + end + + sig { override.returns({ name: T.nilable(String) }) } + def to_hash + end end class Employment < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + # 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)) } + sig do + returns( + T.nilable( + FinchAPI::Sandbox::EmploymentUpdateParams::Employment::Subtype::OrSymbol + ) + ) + end attr_accessor :subtype # The main employment type of the individual. - sig { returns(T.nilable(FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment::Type::OrSymbol)) } + sig do + returns( + T.nilable( + FinchAPI::Sandbox::EmploymentUpdateParams::Employment::Type::OrSymbol + ) + ) + end attr_accessor :type # The employment object. 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) + subtype: + T.nilable( + FinchAPI::Sandbox::EmploymentUpdateParams::Employment::Subtype::OrSymbol + ), + type: + T.nilable( + FinchAPI::Sandbox::EmploymentUpdateParams::Employment::Type::OrSymbol + ) + ).returns(T.attached_class) end def self.new( # The secondary employment type of the individual. Options: `full_time`, @@ -275,17 +367,25 @@ module FinchAPI subtype: nil, # The main employment type of the individual. type: nil - ); end + ) + end + sig do - override - .returns( - { - subtype: T.nilable(FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment::Subtype::OrSymbol), - type: T.nilable(FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment::Type::OrSymbol) - } - ) + override.returns( + { + subtype: + T.nilable( + FinchAPI::Sandbox::EmploymentUpdateParams::Employment::Subtype::OrSymbol + ), + type: + T.nilable( + FinchAPI::Sandbox::EmploymentUpdateParams::Employment::Type::OrSymbol + ) + } + ) + end + def to_hash end - def to_hash; end # The secondary employment type of the individual. Options: `full_time`, # `part_time`, `intern`, `temp`, `seasonal` and `individual_contractor`. @@ -293,29 +393,54 @@ module FinchAPI extend FinchAPI::Internal::Type::Enum TaggedSymbol = - T.type_alias { T.all(Symbol, FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment::Subtype) } + T.type_alias do + T.all( + Symbol, + FinchAPI::Sandbox::EmploymentUpdateParams::Employment::Subtype + ) + end OrSymbol = T.type_alias { T.any(Symbol, String) } FULL_TIME = - T.let(:full_time, FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment::Subtype::TaggedSymbol) + T.let( + :full_time, + FinchAPI::Sandbox::EmploymentUpdateParams::Employment::Subtype::TaggedSymbol + ) INTERN = - T.let(:intern, FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment::Subtype::TaggedSymbol) + T.let( + :intern, + FinchAPI::Sandbox::EmploymentUpdateParams::Employment::Subtype::TaggedSymbol + ) PART_TIME = - T.let(:part_time, FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment::Subtype::TaggedSymbol) - TEMP = T.let(:temp, FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment::Subtype::TaggedSymbol) + T.let( + :part_time, + FinchAPI::Sandbox::EmploymentUpdateParams::Employment::Subtype::TaggedSymbol + ) + TEMP = + T.let( + :temp, + FinchAPI::Sandbox::EmploymentUpdateParams::Employment::Subtype::TaggedSymbol + ) SEASONAL = - T.let(:seasonal, FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment::Subtype::TaggedSymbol) + T.let( + :seasonal, + FinchAPI::Sandbox::EmploymentUpdateParams::Employment::Subtype::TaggedSymbol + ) INDIVIDUAL_CONTRACTOR = T.let( :individual_contractor, - FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment::Subtype::TaggedSymbol + FinchAPI::Sandbox::EmploymentUpdateParams::Employment::Subtype::TaggedSymbol ) sig do - override - .returns(T::Array[FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment::Subtype::TaggedSymbol]) + override.returns( + T::Array[ + FinchAPI::Sandbox::EmploymentUpdateParams::Employment::Subtype::TaggedSymbol + ] + ) + end + def self.values end - def self.values; end end # The main employment type of the individual. @@ -323,19 +448,34 @@ module FinchAPI extend FinchAPI::Internal::Type::Enum TaggedSymbol = - T.type_alias { T.all(Symbol, FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment::Type) } + T.type_alias do + T.all( + Symbol, + FinchAPI::Sandbox::EmploymentUpdateParams::Employment::Type + ) + end OrSymbol = T.type_alias { T.any(Symbol, String) } EMPLOYEE = - T.let(:employee, FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment::Type::TaggedSymbol) + T.let( + :employee, + FinchAPI::Sandbox::EmploymentUpdateParams::Employment::Type::TaggedSymbol + ) CONTRACTOR = - T.let(:contractor, FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment::Type::TaggedSymbol) + T.let( + :contractor, + FinchAPI::Sandbox::EmploymentUpdateParams::Employment::Type::TaggedSymbol + ) sig do - override - .returns(T::Array[FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment::Type::TaggedSymbol]) + override.returns( + T::Array[ + FinchAPI::Sandbox::EmploymentUpdateParams::Employment::Type::TaggedSymbol + ] + ) + end + def self.values end - def self.values; end end end @@ -344,31 +484,65 @@ module FinchAPI extend FinchAPI::Internal::Type::Enum TaggedSymbol = - T.type_alias { T.all(Symbol, FinchAPI::Models::Sandbox::EmploymentUpdateParams::EmploymentStatus) } + T.type_alias do + T.all( + Symbol, + FinchAPI::Sandbox::EmploymentUpdateParams::EmploymentStatus + ) + end OrSymbol = T.type_alias { T.any(Symbol, String) } ACTIVE = - T.let(:active, FinchAPI::Models::Sandbox::EmploymentUpdateParams::EmploymentStatus::TaggedSymbol) + T.let( + :active, + FinchAPI::Sandbox::EmploymentUpdateParams::EmploymentStatus::TaggedSymbol + ) DECEASED = - T.let(:deceased, FinchAPI::Models::Sandbox::EmploymentUpdateParams::EmploymentStatus::TaggedSymbol) - LEAVE = T.let(:leave, FinchAPI::Models::Sandbox::EmploymentUpdateParams::EmploymentStatus::TaggedSymbol) + T.let( + :deceased, + FinchAPI::Sandbox::EmploymentUpdateParams::EmploymentStatus::TaggedSymbol + ) + LEAVE = + T.let( + :leave, + FinchAPI::Sandbox::EmploymentUpdateParams::EmploymentStatus::TaggedSymbol + ) ONBOARDING = - T.let(:onboarding, FinchAPI::Models::Sandbox::EmploymentUpdateParams::EmploymentStatus::TaggedSymbol) + T.let( + :onboarding, + FinchAPI::Sandbox::EmploymentUpdateParams::EmploymentStatus::TaggedSymbol + ) PREHIRE = - T.let(:prehire, FinchAPI::Models::Sandbox::EmploymentUpdateParams::EmploymentStatus::TaggedSymbol) + T.let( + :prehire, + FinchAPI::Sandbox::EmploymentUpdateParams::EmploymentStatus::TaggedSymbol + ) RETIRED = - T.let(:retired, FinchAPI::Models::Sandbox::EmploymentUpdateParams::EmploymentStatus::TaggedSymbol) + T.let( + :retired, + FinchAPI::Sandbox::EmploymentUpdateParams::EmploymentStatus::TaggedSymbol + ) TERMINATED = - T.let(:terminated, FinchAPI::Models::Sandbox::EmploymentUpdateParams::EmploymentStatus::TaggedSymbol) + T.let( + :terminated, + FinchAPI::Sandbox::EmploymentUpdateParams::EmploymentStatus::TaggedSymbol + ) sig do - override - .returns(T::Array[FinchAPI::Models::Sandbox::EmploymentUpdateParams::EmploymentStatus::TaggedSymbol]) + override.returns( + T::Array[ + FinchAPI::Sandbox::EmploymentUpdateParams::EmploymentStatus::TaggedSymbol + ] + ) + end + def self.values end - def self.values; end end class Manager < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + # A stable Finch `id` (UUID v4) for an individual in the company. sig { returns(T.nilable(String)) } attr_reader :id @@ -381,9 +555,12 @@ module FinchAPI def self.new( # A stable Finch `id` (UUID v4) for an individual in the company. id: nil - ); end - sig { override.returns({id: String}) } - def to_hash; end + ) + end + + sig { override.returns({ id: String }) } + def to_hash + end end end end diff --git a/rbi/finch_api/models/sandbox/employment_update_response.rbi b/rbi/finch_api/models/sandbox/employment_update_response.rbi index 12c464aa..c04017b7 100644 --- a/rbi/finch_api/models/sandbox/employment_update_response.rbi +++ b/rbi/finch_api/models/sandbox/employment_update_response.rbi @@ -4,6 +4,9 @@ module FinchAPI module Models module Sandbox class EmploymentUpdateResponse < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + # A stable Finch `id` (UUID v4) for an individual in the company. sig { returns(T.nilable(String)) } attr_reader :id @@ -18,47 +21,75 @@ module FinchAPI # 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])) } + sig do + returns( + T.nilable( + T::Array[ + FinchAPI::Models::Sandbox::EmploymentUpdateResponse::CustomField + ] + ) + ) + end attr_reader :custom_fields sig do params( - custom_fields: T::Array[T.any(FinchAPI::Models::Sandbox::EmploymentUpdateResponse::CustomField, FinchAPI::Internal::AnyHash)] - ) - .void + custom_fields: + T::Array[ + FinchAPI::Models::Sandbox::EmploymentUpdateResponse::CustomField::OrHash + ] + ).void end attr_writer :custom_fields # The department object. - sig { returns(T.nilable(FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Department)) } + sig do + returns( + T.nilable( + FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Department + ) + ) + end attr_reader :department sig do params( - department: T.nilable( - T.any(FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Department, FinchAPI::Internal::AnyHash) - ) - ) - .void + department: + T.nilable( + FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Department::OrHash + ) + ).void end attr_writer :department # The employment object. - sig { returns(T.nilable(FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Employment)) } + sig do + returns( + T.nilable( + FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Employment + ) + ) + end attr_reader :employment sig do params( - employment: T.nilable( - T.any(FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Employment, FinchAPI::Internal::AnyHash) - ) - ) - .void + employment: + T.nilable( + FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Employment::OrHash + ) + ).void end attr_writer :employment # The detailed employment status of the individual. - sig { returns(T.nilable(FinchAPI::Models::Sandbox::EmploymentUpdateResponse::EmploymentStatus::TaggedSymbol)) } + sig do + returns( + T.nilable( + FinchAPI::Models::Sandbox::EmploymentUpdateResponse::EmploymentStatus::TaggedSymbol + ) + ) + end attr_accessor :employment_status sig { returns(T.nilable(String)) } @@ -71,14 +102,14 @@ module FinchAPI # 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)) } + sig { returns(T.nilable(FinchAPI::Income)) } attr_reader :income - sig { params(income: T.nilable(T.any(FinchAPI::Models::Income, FinchAPI::Internal::AnyHash))).void } + sig { params(income: T.nilable(FinchAPI::Income::OrHash)).void } attr_writer :income # The array of income history. - sig { returns(T.nilable(T::Array[T.nilable(FinchAPI::Models::Income)])) } + sig { returns(T.nilable(T::Array[T.nilable(FinchAPI::Income)])) } attr_accessor :income_history # `true` if the individual an an active employee or contractor at the company. @@ -92,23 +123,29 @@ module FinchAPI sig { returns(T.nilable(String)) } attr_accessor :latest_rehire_date - sig { returns(T.nilable(FinchAPI::Models::Location)) } + sig { returns(T.nilable(FinchAPI::Location)) } attr_reader :location - sig { params(location: T.nilable(T.any(FinchAPI::Models::Location, FinchAPI::Internal::AnyHash))).void } + sig { params(location: T.nilable(FinchAPI::Location::OrHash)).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)) } + sig do + returns( + T.nilable( + FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Manager + ) + ) + end attr_reader :manager sig do params( - manager: T.nilable( - T.any(FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Manager, FinchAPI::Internal::AnyHash) - ) - ) - .void + manager: + T.nilable( + FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Manager::OrHash + ) + ).void end attr_writer :manager @@ -134,31 +171,40 @@ module FinchAPI params( id: String, class_code: T.nilable(String), - custom_fields: T::Array[T.any(FinchAPI::Models::Sandbox::EmploymentUpdateResponse::CustomField, FinchAPI::Internal::AnyHash)], - department: T.nilable( - T.any(FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Department, FinchAPI::Internal::AnyHash) - ), - employment: T.nilable( - T.any(FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Employment, FinchAPI::Internal::AnyHash) - ), - employment_status: T.nilable(FinchAPI::Models::Sandbox::EmploymentUpdateResponse::EmploymentStatus::OrSymbol), + custom_fields: + T::Array[ + FinchAPI::Models::Sandbox::EmploymentUpdateResponse::CustomField::OrHash + ], + department: + T.nilable( + FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Department::OrHash + ), + employment: + T.nilable( + FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Employment::OrHash + ), + 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::Internal::AnyHash)), - income_history: T.nilable(T::Array[T.nilable(T.any(FinchAPI::Models::Income, FinchAPI::Internal::AnyHash))]), + income: T.nilable(FinchAPI::Income::OrHash), + income_history: + T.nilable(T::Array[T.nilable(FinchAPI::Income::OrHash)]), 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::Internal::AnyHash)), - manager: T.nilable( - T.any(FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Manager, FinchAPI::Internal::AnyHash) - ), + location: T.nilable(FinchAPI::Location::OrHash), + manager: + T.nilable( + FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Manager::OrHash + ), middle_name: T.nilable(String), source_id: String, start_date: T.nilable(String), title: T.nilable(String) - ) - .returns(T.attached_class) + ).returns(T.attached_class) end def self.new( # A stable Finch `id` (UUID v4) for an individual in the company. @@ -199,36 +245,56 @@ module FinchAPI start_date: nil, # The current title of the individual. title: nil - ); end + ) + end + sig do - override - .returns( - { - 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), - 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_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), - middle_name: T.nilable(String), - source_id: String, - start_date: T.nilable(String), - title: T.nilable(String) - } - ) + override.returns( + { + 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 + ), + employment_status: + T.nilable( + FinchAPI::Models::Sandbox::EmploymentUpdateResponse::EmploymentStatus::TaggedSymbol + ), + end_date: T.nilable(String), + first_name: T.nilable(String), + income: T.nilable(FinchAPI::Income), + income_history: T.nilable(T::Array[T.nilable(FinchAPI::Income)]), + is_active: T.nilable(T::Boolean), + last_name: T.nilable(String), + latest_rehire_date: T.nilable(String), + location: T.nilable(FinchAPI::Location), + manager: + T.nilable( + FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Manager + ), + middle_name: T.nilable(String), + source_id: String, + start_date: T.nilable(String), + title: T.nilable(String) + } + ) + end + def to_hash end - def to_hash; end class CustomField < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + sig { returns(T.nilable(String)) } attr_accessor :name @@ -238,14 +304,25 @@ module FinchAPI 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); end + sig do + params(name: T.nilable(String), value: T.anything).returns( + T.attached_class + ) + end + def self.new(name: nil, value: nil) + end - sig { override.returns({name: T.nilable(String), value: T.anything}) } - def to_hash; end + sig do + override.returns({ name: T.nilable(String), value: T.anything }) + end + def to_hash + end end class Department < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + # The name of the department associated with the individual. sig { returns(T.nilable(String)) } attr_accessor :name @@ -255,28 +332,51 @@ module FinchAPI def self.new( # The name of the department associated with the individual. name: nil - ); end - sig { override.returns({name: T.nilable(String)}) } - def to_hash; end + ) + end + + sig { override.returns({ name: T.nilable(String) }) } + def to_hash + end end class Employment < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + # 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)) } + sig do + returns( + T.nilable( + FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Employment::Subtype::TaggedSymbol + ) + ) + end attr_accessor :subtype # The main employment type of the individual. - sig { returns(T.nilable(FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Employment::Type::TaggedSymbol)) } + sig do + returns( + T.nilable( + FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Employment::Type::TaggedSymbol + ) + ) + end attr_accessor :type # The employment object. sig do params( - subtype: T.nilable(FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Employment::Subtype::OrSymbol), - type: T.nilable(FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Employment::Type::OrSymbol) - ) - .returns(T.attached_class) + 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 def self.new( # The secondary employment type of the individual. Options: `full_time`, @@ -284,17 +384,25 @@ module FinchAPI subtype: nil, # The main employment type of the individual. type: nil - ); end + ) + end + sig do - override - .returns( - { - subtype: T.nilable(FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Employment::Subtype::TaggedSymbol), - type: T.nilable(FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Employment::Type::TaggedSymbol) - } - ) + 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 - def to_hash; end # The secondary employment type of the individual. Options: `full_time`, # `part_time`, `intern`, `temp`, `seasonal` and `individual_contractor`. @@ -302,19 +410,39 @@ module FinchAPI extend FinchAPI::Internal::Type::Enum TaggedSymbol = - T.type_alias { T.all(Symbol, FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Employment::Subtype) } + T.type_alias do + T.all( + Symbol, + FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Employment::Subtype + ) + end OrSymbol = T.type_alias { T.any(Symbol, String) } FULL_TIME = - T.let(:full_time, FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Employment::Subtype::TaggedSymbol) + T.let( + :full_time, + FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Employment::Subtype::TaggedSymbol + ) INTERN = - T.let(:intern, FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Employment::Subtype::TaggedSymbol) + T.let( + :intern, + FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Employment::Subtype::TaggedSymbol + ) PART_TIME = - T.let(:part_time, FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Employment::Subtype::TaggedSymbol) + T.let( + :part_time, + FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Employment::Subtype::TaggedSymbol + ) TEMP = - T.let(:temp, FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Employment::Subtype::TaggedSymbol) + T.let( + :temp, + FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Employment::Subtype::TaggedSymbol + ) SEASONAL = - T.let(:seasonal, FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Employment::Subtype::TaggedSymbol) + T.let( + :seasonal, + FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Employment::Subtype::TaggedSymbol + ) INDIVIDUAL_CONTRACTOR = T.let( :individual_contractor, @@ -322,10 +450,14 @@ module FinchAPI ) sig do - override - .returns(T::Array[FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Employment::Subtype::TaggedSymbol]) + override.returns( + T::Array[ + FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Employment::Subtype::TaggedSymbol + ] + ) + end + def self.values end - def self.values; end end # The main employment type of the individual. @@ -333,19 +465,34 @@ module FinchAPI extend FinchAPI::Internal::Type::Enum TaggedSymbol = - T.type_alias { T.all(Symbol, FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Employment::Type) } + T.type_alias do + T.all( + Symbol, + FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Employment::Type + ) + end OrSymbol = T.type_alias { T.any(Symbol, String) } EMPLOYEE = - T.let(:employee, FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Employment::Type::TaggedSymbol) + T.let( + :employee, + FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Employment::Type::TaggedSymbol + ) CONTRACTOR = - T.let(:contractor, FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Employment::Type::TaggedSymbol) + T.let( + :contractor, + FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Employment::Type::TaggedSymbol + ) sig do - override - .returns(T::Array[FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Employment::Type::TaggedSymbol]) + override.returns( + T::Array[ + FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Employment::Type::TaggedSymbol + ] + ) + end + def self.values end - def self.values; end end end @@ -354,32 +501,65 @@ module FinchAPI extend FinchAPI::Internal::Type::Enum TaggedSymbol = - T.type_alias { T.all(Symbol, FinchAPI::Models::Sandbox::EmploymentUpdateResponse::EmploymentStatus) } + T.type_alias do + T.all( + Symbol, + FinchAPI::Models::Sandbox::EmploymentUpdateResponse::EmploymentStatus + ) + end OrSymbol = T.type_alias { T.any(Symbol, String) } ACTIVE = - T.let(:active, FinchAPI::Models::Sandbox::EmploymentUpdateResponse::EmploymentStatus::TaggedSymbol) + T.let( + :active, + FinchAPI::Models::Sandbox::EmploymentUpdateResponse::EmploymentStatus::TaggedSymbol + ) DECEASED = - T.let(:deceased, FinchAPI::Models::Sandbox::EmploymentUpdateResponse::EmploymentStatus::TaggedSymbol) + T.let( + :deceased, + FinchAPI::Models::Sandbox::EmploymentUpdateResponse::EmploymentStatus::TaggedSymbol + ) LEAVE = - T.let(:leave, FinchAPI::Models::Sandbox::EmploymentUpdateResponse::EmploymentStatus::TaggedSymbol) + T.let( + :leave, + FinchAPI::Models::Sandbox::EmploymentUpdateResponse::EmploymentStatus::TaggedSymbol + ) ONBOARDING = - T.let(:onboarding, FinchAPI::Models::Sandbox::EmploymentUpdateResponse::EmploymentStatus::TaggedSymbol) + T.let( + :onboarding, + FinchAPI::Models::Sandbox::EmploymentUpdateResponse::EmploymentStatus::TaggedSymbol + ) PREHIRE = - T.let(:prehire, FinchAPI::Models::Sandbox::EmploymentUpdateResponse::EmploymentStatus::TaggedSymbol) + T.let( + :prehire, + FinchAPI::Models::Sandbox::EmploymentUpdateResponse::EmploymentStatus::TaggedSymbol + ) RETIRED = - T.let(:retired, FinchAPI::Models::Sandbox::EmploymentUpdateResponse::EmploymentStatus::TaggedSymbol) + T.let( + :retired, + FinchAPI::Models::Sandbox::EmploymentUpdateResponse::EmploymentStatus::TaggedSymbol + ) TERMINATED = - T.let(:terminated, FinchAPI::Models::Sandbox::EmploymentUpdateResponse::EmploymentStatus::TaggedSymbol) + T.let( + :terminated, + FinchAPI::Models::Sandbox::EmploymentUpdateResponse::EmploymentStatus::TaggedSymbol + ) sig do - override - .returns(T::Array[FinchAPI::Models::Sandbox::EmploymentUpdateResponse::EmploymentStatus::TaggedSymbol]) + override.returns( + T::Array[ + FinchAPI::Models::Sandbox::EmploymentUpdateResponse::EmploymentStatus::TaggedSymbol + ] + ) + end + def self.values end - def self.values; end end class Manager < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + # A stable Finch `id` (UUID v4) for an individual in the company. sig { returns(T.nilable(String)) } attr_reader :id @@ -392,9 +572,12 @@ module FinchAPI def self.new( # A stable Finch `id` (UUID v4) for an individual in the company. id: nil - ); end - sig { override.returns({id: String}) } - def to_hash; end + ) + end + + sig { override.returns({ id: String }) } + def to_hash + end end end end diff --git a/rbi/finch_api/models/sandbox/individual_update_params.rbi b/rbi/finch_api/models/sandbox/individual_update_params.rbi index b0c642d6..a6b8a9f1 100644 --- a/rbi/finch_api/models/sandbox/individual_update_params.rbi +++ b/rbi/finch_api/models/sandbox/individual_update_params.rbi @@ -7,10 +7,19 @@ module FinchAPI extend FinchAPI::Internal::Type::RequestParameters::Converter include FinchAPI::Internal::Type::RequestParameters + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + sig { returns(T.nilable(String)) } attr_accessor :dob - sig { returns(T.nilable(T::Array[FinchAPI::Models::Sandbox::IndividualUpdateParams::Email])) } + sig do + returns( + T.nilable( + T::Array[FinchAPI::Sandbox::IndividualUpdateParams::Email] + ) + ) + end attr_accessor :emails # Social Security Number of the individual in **encrypted** format. This field is @@ -20,7 +29,13 @@ module FinchAPI attr_accessor :encrypted_ssn # The EEOC-defined ethnicity of the individual. - sig { returns(T.nilable(FinchAPI::Models::Sandbox::IndividualUpdateParams::Ethnicity::OrSymbol)) } + sig do + returns( + T.nilable( + FinchAPI::Sandbox::IndividualUpdateParams::Ethnicity::OrSymbol + ) + ) + end attr_accessor :ethnicity # The legal first name of the individual. @@ -28,7 +43,13 @@ module FinchAPI attr_accessor :first_name # The gender of the individual. - sig { returns(T.nilable(FinchAPI::Models::Sandbox::IndividualUpdateParams::Gender::OrSymbol)) } + sig do + returns( + T.nilable( + FinchAPI::Sandbox::IndividualUpdateParams::Gender::OrSymbol + ) + ) + end attr_accessor :gender # The legal last name of the individual. @@ -39,17 +60,27 @@ module FinchAPI sig { returns(T.nilable(String)) } attr_accessor :middle_name - sig { returns(T.nilable(T::Array[T.nilable(FinchAPI::Models::Sandbox::IndividualUpdateParams::PhoneNumber)])) } + sig do + returns( + T.nilable( + T::Array[ + T.nilable( + FinchAPI::Sandbox::IndividualUpdateParams::PhoneNumber + ) + ] + ) + ) + end attr_accessor :phone_numbers # The preferred name of the individual. sig { returns(T.nilable(String)) } attr_accessor :preferred_name - sig { returns(T.nilable(FinchAPI::Models::Location)) } + sig { returns(T.nilable(FinchAPI::Location)) } attr_reader :residence - sig { params(residence: T.nilable(T.any(FinchAPI::Models::Location, FinchAPI::Internal::AnyHash))).void } + sig { params(residence: T.nilable(FinchAPI::Location::OrHash)).void } attr_writer :residence # Social Security Number of the individual. This field is only available with the @@ -62,28 +93,37 @@ module FinchAPI sig do params( dob: T.nilable(String), - emails: T.nilable( - T::Array[T.any(FinchAPI::Models::Sandbox::IndividualUpdateParams::Email, FinchAPI::Internal::AnyHash)] - ), + emails: + T.nilable( + T::Array[ + FinchAPI::Sandbox::IndividualUpdateParams::Email::OrHash + ] + ), encrypted_ssn: T.nilable(String), - ethnicity: T.nilable(FinchAPI::Models::Sandbox::IndividualUpdateParams::Ethnicity::OrSymbol), + ethnicity: + T.nilable( + FinchAPI::Sandbox::IndividualUpdateParams::Ethnicity::OrSymbol + ), first_name: T.nilable(String), - gender: T.nilable(FinchAPI::Models::Sandbox::IndividualUpdateParams::Gender::OrSymbol), + gender: + T.nilable( + FinchAPI::Sandbox::IndividualUpdateParams::Gender::OrSymbol + ), last_name: T.nilable(String), middle_name: T.nilable(String), - phone_numbers: T.nilable( - T::Array[ - T.nilable( - T.any(FinchAPI::Models::Sandbox::IndividualUpdateParams::PhoneNumber, FinchAPI::Internal::AnyHash) - ) - ] - ), + phone_numbers: + T.nilable( + T::Array[ + T.nilable( + FinchAPI::Sandbox::IndividualUpdateParams::PhoneNumber::OrHash + ) + ] + ), preferred_name: T.nilable(String), - residence: T.nilable(T.any(FinchAPI::Models::Location, FinchAPI::Internal::AnyHash)), + residence: T.nilable(FinchAPI::Location::OrHash), ssn: T.nilable(String), - request_options: T.any(FinchAPI::RequestOptions, FinchAPI::Internal::AnyHash) - ) - .returns(T.attached_class) + request_options: FinchAPI::RequestOptions::OrHash + ).returns(T.attached_class) end def self.new( dob: nil, @@ -112,68 +152,124 @@ module FinchAPI # [Click here to learn more about enabling the SSN field](/developer-resources/Enable-SSN-Field). ssn: nil, request_options: {} - ); end + ) + end + sig do - override - .returns( - { - dob: T.nilable(String), - emails: T.nilable(T::Array[FinchAPI::Models::Sandbox::IndividualUpdateParams::Email]), - 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)]), - preferred_name: T.nilable(String), - residence: T.nilable(FinchAPI::Models::Location), - ssn: T.nilable(String), - request_options: FinchAPI::RequestOptions - } - ) + override.returns( + { + dob: T.nilable(String), + emails: + T.nilable( + T::Array[FinchAPI::Sandbox::IndividualUpdateParams::Email] + ), + encrypted_ssn: T.nilable(String), + ethnicity: + T.nilable( + FinchAPI::Sandbox::IndividualUpdateParams::Ethnicity::OrSymbol + ), + first_name: T.nilable(String), + gender: + T.nilable( + FinchAPI::Sandbox::IndividualUpdateParams::Gender::OrSymbol + ), + last_name: T.nilable(String), + middle_name: T.nilable(String), + phone_numbers: + T.nilable( + T::Array[ + T.nilable( + FinchAPI::Sandbox::IndividualUpdateParams::PhoneNumber + ) + ] + ), + preferred_name: T.nilable(String), + residence: T.nilable(FinchAPI::Location), + ssn: T.nilable(String), + request_options: FinchAPI::RequestOptions + } + ) + end + def to_hash end - def to_hash; end class Email < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + sig { returns(T.nilable(String)) } attr_reader :data sig { params(data: String).void } attr_writer :data - sig { returns(T.nilable(FinchAPI::Models::Sandbox::IndividualUpdateParams::Email::Type::OrSymbol)) } + sig do + returns( + T.nilable( + FinchAPI::Sandbox::IndividualUpdateParams::Email::Type::OrSymbol + ) + ) + end attr_accessor :type sig do params( data: String, - type: T.nilable(FinchAPI::Models::Sandbox::IndividualUpdateParams::Email::Type::OrSymbol) - ) - .returns(T.attached_class) + type: + T.nilable( + FinchAPI::Sandbox::IndividualUpdateParams::Email::Type::OrSymbol + ) + ).returns(T.attached_class) + end + def self.new(data: nil, type: nil) end - def self.new(data: nil, type: nil); end sig do - override - .returns( - {data: String, type: T.nilable(FinchAPI::Models::Sandbox::IndividualUpdateParams::Email::Type::OrSymbol)} - ) + override.returns( + { + data: String, + type: + T.nilable( + FinchAPI::Sandbox::IndividualUpdateParams::Email::Type::OrSymbol + ) + } + ) + end + def to_hash end - def to_hash; end module Type extend FinchAPI::Internal::Type::Enum TaggedSymbol = - T.type_alias { T.all(Symbol, FinchAPI::Models::Sandbox::IndividualUpdateParams::Email::Type) } + T.type_alias do + T.all( + Symbol, + FinchAPI::Sandbox::IndividualUpdateParams::Email::Type + ) + end OrSymbol = T.type_alias { T.any(Symbol, String) } - WORK = T.let(:work, FinchAPI::Models::Sandbox::IndividualUpdateParams::Email::Type::TaggedSymbol) - PERSONAL = T.let(:personal, FinchAPI::Models::Sandbox::IndividualUpdateParams::Email::Type::TaggedSymbol) + WORK = + T.let( + :work, + FinchAPI::Sandbox::IndividualUpdateParams::Email::Type::TaggedSymbol + ) + PERSONAL = + T.let( + :personal, + FinchAPI::Sandbox::IndividualUpdateParams::Email::Type::TaggedSymbol + ) - sig { override.returns(T::Array[FinchAPI::Models::Sandbox::IndividualUpdateParams::Email::Type::TaggedSymbol]) } - def self.values; end + sig do + override.returns( + T::Array[ + FinchAPI::Sandbox::IndividualUpdateParams::Email::Type::TaggedSymbol + ] + ) + end + def self.values + end end end @@ -182,97 +278,182 @@ module FinchAPI extend FinchAPI::Internal::Type::Enum TaggedSymbol = - T.type_alias { T.all(Symbol, FinchAPI::Models::Sandbox::IndividualUpdateParams::Ethnicity) } + T.type_alias do + T.all( + Symbol, + FinchAPI::Sandbox::IndividualUpdateParams::Ethnicity + ) + end OrSymbol = T.type_alias { T.any(Symbol, String) } - ASIAN = T.let(:asian, FinchAPI::Models::Sandbox::IndividualUpdateParams::Ethnicity::TaggedSymbol) - WHITE = T.let(:white, FinchAPI::Models::Sandbox::IndividualUpdateParams::Ethnicity::TaggedSymbol) + ASIAN = + T.let( + :asian, + FinchAPI::Sandbox::IndividualUpdateParams::Ethnicity::TaggedSymbol + ) + WHITE = + T.let( + :white, + FinchAPI::Sandbox::IndividualUpdateParams::Ethnicity::TaggedSymbol + ) BLACK_OR_AFRICAN_AMERICAN = T.let( :black_or_african_american, - FinchAPI::Models::Sandbox::IndividualUpdateParams::Ethnicity::TaggedSymbol + FinchAPI::Sandbox::IndividualUpdateParams::Ethnicity::TaggedSymbol ) NATIVE_HAWAIIAN_OR_PACIFIC_ISLANDER = T.let( :native_hawaiian_or_pacific_islander, - FinchAPI::Models::Sandbox::IndividualUpdateParams::Ethnicity::TaggedSymbol + FinchAPI::Sandbox::IndividualUpdateParams::Ethnicity::TaggedSymbol ) AMERICAN_INDIAN_OR_ALASKA_NATIVE = T.let( :american_indian_or_alaska_native, - FinchAPI::Models::Sandbox::IndividualUpdateParams::Ethnicity::TaggedSymbol + FinchAPI::Sandbox::IndividualUpdateParams::Ethnicity::TaggedSymbol ) HISPANIC_OR_LATINO = - T.let(:hispanic_or_latino, FinchAPI::Models::Sandbox::IndividualUpdateParams::Ethnicity::TaggedSymbol) + T.let( + :hispanic_or_latino, + FinchAPI::Sandbox::IndividualUpdateParams::Ethnicity::TaggedSymbol + ) TWO_OR_MORE_RACES = - T.let(:two_or_more_races, FinchAPI::Models::Sandbox::IndividualUpdateParams::Ethnicity::TaggedSymbol) + T.let( + :two_or_more_races, + FinchAPI::Sandbox::IndividualUpdateParams::Ethnicity::TaggedSymbol + ) DECLINE_TO_SPECIFY = - T.let(:decline_to_specify, FinchAPI::Models::Sandbox::IndividualUpdateParams::Ethnicity::TaggedSymbol) + T.let( + :decline_to_specify, + FinchAPI::Sandbox::IndividualUpdateParams::Ethnicity::TaggedSymbol + ) - sig { override.returns(T::Array[FinchAPI::Models::Sandbox::IndividualUpdateParams::Ethnicity::TaggedSymbol]) } - def self.values; end + sig do + override.returns( + T::Array[ + FinchAPI::Sandbox::IndividualUpdateParams::Ethnicity::TaggedSymbol + ] + ) + end + def self.values + end end # The gender of the individual. module Gender extend FinchAPI::Internal::Type::Enum - TaggedSymbol = T.type_alias { T.all(Symbol, FinchAPI::Models::Sandbox::IndividualUpdateParams::Gender) } + TaggedSymbol = + T.type_alias do + T.all(Symbol, FinchAPI::Sandbox::IndividualUpdateParams::Gender) + end OrSymbol = T.type_alias { T.any(Symbol, String) } - 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) + FEMALE = + T.let( + :female, + FinchAPI::Sandbox::IndividualUpdateParams::Gender::TaggedSymbol + ) + MALE = + T.let( + :male, + FinchAPI::Sandbox::IndividualUpdateParams::Gender::TaggedSymbol + ) + OTHER = + T.let( + :other, + FinchAPI::Sandbox::IndividualUpdateParams::Gender::TaggedSymbol + ) DECLINE_TO_SPECIFY = - T.let(:decline_to_specify, FinchAPI::Models::Sandbox::IndividualUpdateParams::Gender::TaggedSymbol) + T.let( + :decline_to_specify, + FinchAPI::Sandbox::IndividualUpdateParams::Gender::TaggedSymbol + ) - sig { override.returns(T::Array[FinchAPI::Models::Sandbox::IndividualUpdateParams::Gender::TaggedSymbol]) } - def self.values; end + sig do + override.returns( + T::Array[ + FinchAPI::Sandbox::IndividualUpdateParams::Gender::TaggedSymbol + ] + ) + end + def self.values + end end class PhoneNumber < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + sig { returns(T.nilable(String)) } attr_accessor :data - sig { returns(T.nilable(FinchAPI::Models::Sandbox::IndividualUpdateParams::PhoneNumber::Type::OrSymbol)) } + sig do + returns( + T.nilable( + FinchAPI::Sandbox::IndividualUpdateParams::PhoneNumber::Type::OrSymbol + ) + ) + end attr_accessor :type sig do params( data: T.nilable(String), - type: T.nilable(FinchAPI::Models::Sandbox::IndividualUpdateParams::PhoneNumber::Type::OrSymbol) - ) - .returns(T.attached_class) + type: + T.nilable( + FinchAPI::Sandbox::IndividualUpdateParams::PhoneNumber::Type::OrSymbol + ) + ).returns(T.attached_class) + end + def self.new(data: nil, type: nil) end - def self.new(data: nil, type: nil); end sig do - override - .returns( - { - data: T.nilable(String), - type: T.nilable(FinchAPI::Models::Sandbox::IndividualUpdateParams::PhoneNumber::Type::OrSymbol) - } - ) + override.returns( + { + data: T.nilable(String), + type: + T.nilable( + FinchAPI::Sandbox::IndividualUpdateParams::PhoneNumber::Type::OrSymbol + ) + } + ) + end + def to_hash end - def to_hash; end module Type extend FinchAPI::Internal::Type::Enum TaggedSymbol = - T.type_alias { T.all(Symbol, FinchAPI::Models::Sandbox::IndividualUpdateParams::PhoneNumber::Type) } + T.type_alias do + T.all( + Symbol, + FinchAPI::Sandbox::IndividualUpdateParams::PhoneNumber::Type + ) + end OrSymbol = T.type_alias { T.any(Symbol, String) } - WORK = T.let(:work, FinchAPI::Models::Sandbox::IndividualUpdateParams::PhoneNumber::Type::TaggedSymbol) + WORK = + T.let( + :work, + FinchAPI::Sandbox::IndividualUpdateParams::PhoneNumber::Type::TaggedSymbol + ) PERSONAL = - T.let(:personal, FinchAPI::Models::Sandbox::IndividualUpdateParams::PhoneNumber::Type::TaggedSymbol) + T.let( + :personal, + FinchAPI::Sandbox::IndividualUpdateParams::PhoneNumber::Type::TaggedSymbol + ) sig do - override - .returns(T::Array[FinchAPI::Models::Sandbox::IndividualUpdateParams::PhoneNumber::Type::TaggedSymbol]) + override.returns( + T::Array[ + FinchAPI::Sandbox::IndividualUpdateParams::PhoneNumber::Type::TaggedSymbol + ] + ) + end + def self.values end - def self.values; end end end end diff --git a/rbi/finch_api/models/sandbox/individual_update_response.rbi b/rbi/finch_api/models/sandbox/individual_update_response.rbi index cd1b6a13..c3f3a3bf 100644 --- a/rbi/finch_api/models/sandbox/individual_update_response.rbi +++ b/rbi/finch_api/models/sandbox/individual_update_response.rbi @@ -4,6 +4,9 @@ module FinchAPI module Models module Sandbox class IndividualUpdateResponse < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + # A stable Finch `id` (UUID v4) for an individual in the company. sig { returns(T.nilable(String)) } attr_reader :id @@ -14,7 +17,15 @@ module FinchAPI sig { returns(T.nilable(String)) } attr_accessor :dob - sig { returns(T.nilable(T::Array[FinchAPI::Models::Sandbox::IndividualUpdateResponse::Email])) } + sig do + returns( + T.nilable( + T::Array[ + FinchAPI::Models::Sandbox::IndividualUpdateResponse::Email + ] + ) + ) + end attr_accessor :emails # Social Security Number of the individual in **encrypted** format. This field is @@ -24,7 +35,13 @@ module FinchAPI attr_accessor :encrypted_ssn # The EEOC-defined ethnicity of the individual. - sig { returns(T.nilable(FinchAPI::Models::Sandbox::IndividualUpdateResponse::Ethnicity::TaggedSymbol)) } + sig do + returns( + T.nilable( + FinchAPI::Models::Sandbox::IndividualUpdateResponse::Ethnicity::TaggedSymbol + ) + ) + end attr_accessor :ethnicity # The legal first name of the individual. @@ -32,7 +49,13 @@ module FinchAPI attr_accessor :first_name # The gender of the individual. - sig { returns(T.nilable(FinchAPI::Models::Sandbox::IndividualUpdateResponse::Gender::TaggedSymbol)) } + sig do + returns( + T.nilable( + FinchAPI::Models::Sandbox::IndividualUpdateResponse::Gender::TaggedSymbol + ) + ) + end attr_accessor :gender # The legal last name of the individual. @@ -43,17 +66,27 @@ module FinchAPI sig { returns(T.nilable(String)) } attr_accessor :middle_name - sig { returns(T.nilable(T::Array[T.nilable(FinchAPI::Models::Sandbox::IndividualUpdateResponse::PhoneNumber)])) } + sig do + returns( + T.nilable( + T::Array[ + T.nilable( + FinchAPI::Models::Sandbox::IndividualUpdateResponse::PhoneNumber + ) + ] + ) + ) + end attr_accessor :phone_numbers # The preferred name of the individual. sig { returns(T.nilable(String)) } attr_accessor :preferred_name - sig { returns(T.nilable(FinchAPI::Models::Location)) } + sig { returns(T.nilable(FinchAPI::Location)) } attr_reader :residence - sig { params(residence: T.nilable(T.any(FinchAPI::Models::Location, FinchAPI::Internal::AnyHash))).void } + sig { params(residence: T.nilable(FinchAPI::Location::OrHash)).void } attr_writer :residence # Social Security Number of the individual. This field is only available with the @@ -67,27 +100,36 @@ module FinchAPI params( id: String, dob: T.nilable(String), - emails: T.nilable( - T::Array[T.any(FinchAPI::Models::Sandbox::IndividualUpdateResponse::Email, FinchAPI::Internal::AnyHash)] - ), + emails: + T.nilable( + T::Array[ + FinchAPI::Models::Sandbox::IndividualUpdateResponse::Email::OrHash + ] + ), encrypted_ssn: T.nilable(String), - ethnicity: T.nilable(FinchAPI::Models::Sandbox::IndividualUpdateResponse::Ethnicity::OrSymbol), + ethnicity: + T.nilable( + FinchAPI::Models::Sandbox::IndividualUpdateResponse::Ethnicity::OrSymbol + ), first_name: T.nilable(String), - gender: T.nilable(FinchAPI::Models::Sandbox::IndividualUpdateResponse::Gender::OrSymbol), + 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( - T.any(FinchAPI::Models::Sandbox::IndividualUpdateResponse::PhoneNumber, FinchAPI::Internal::AnyHash) - ) - ] - ), + phone_numbers: + T.nilable( + T::Array[ + T.nilable( + FinchAPI::Models::Sandbox::IndividualUpdateResponse::PhoneNumber::OrHash + ) + ] + ), preferred_name: T.nilable(String), - residence: T.nilable(T.any(FinchAPI::Models::Location, FinchAPI::Internal::AnyHash)), + residence: T.nilable(FinchAPI::Location::OrHash), ssn: T.nilable(String) - ) - .returns(T.attached_class) + ).returns(T.attached_class) end def self.new( # A stable Finch `id` (UUID v4) for an individual in the company. @@ -117,72 +159,126 @@ module FinchAPI # body. # [Click here to learn more about enabling the SSN field](/developer-resources/Enable-SSN-Field). ssn: nil - ); end + ) + end + sig do - override - .returns( - { - id: String, - dob: T.nilable(String), - emails: T.nilable(T::Array[FinchAPI::Models::Sandbox::IndividualUpdateResponse::Email]), - encrypted_ssn: T.nilable(String), - ethnicity: T.nilable(FinchAPI::Models::Sandbox::IndividualUpdateResponse::Ethnicity::TaggedSymbol), - first_name: T.nilable(String), - 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)]), - preferred_name: T.nilable(String), - residence: T.nilable(FinchAPI::Models::Location), - ssn: T.nilable(String) - } - ) + override.returns( + { + id: String, + dob: T.nilable(String), + emails: + T.nilable( + T::Array[ + FinchAPI::Models::Sandbox::IndividualUpdateResponse::Email + ] + ), + encrypted_ssn: T.nilable(String), + ethnicity: + T.nilable( + FinchAPI::Models::Sandbox::IndividualUpdateResponse::Ethnicity::TaggedSymbol + ), + first_name: T.nilable(String), + 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 + ) + ] + ), + preferred_name: T.nilable(String), + residence: T.nilable(FinchAPI::Location), + ssn: T.nilable(String) + } + ) + end + def to_hash end - def to_hash; end class Email < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + sig { returns(T.nilable(String)) } attr_reader :data sig { params(data: String).void } attr_writer :data - sig { returns(T.nilable(FinchAPI::Models::Sandbox::IndividualUpdateResponse::Email::Type::TaggedSymbol)) } + sig do + returns( + T.nilable( + FinchAPI::Models::Sandbox::IndividualUpdateResponse::Email::Type::TaggedSymbol + ) + ) + end attr_accessor :type sig do params( data: String, - type: T.nilable(FinchAPI::Models::Sandbox::IndividualUpdateResponse::Email::Type::OrSymbol) - ) - .returns(T.attached_class) + type: + T.nilable( + FinchAPI::Models::Sandbox::IndividualUpdateResponse::Email::Type::OrSymbol + ) + ).returns(T.attached_class) + end + def self.new(data: nil, type: nil) end - def self.new(data: nil, type: nil); end sig do - override - .returns( - { - data: String, - type: T.nilable(FinchAPI::Models::Sandbox::IndividualUpdateResponse::Email::Type::TaggedSymbol) - } - ) + override.returns( + { + data: String, + type: + T.nilable( + FinchAPI::Models::Sandbox::IndividualUpdateResponse::Email::Type::TaggedSymbol + ) + } + ) + end + def to_hash end - def to_hash; end module Type extend FinchAPI::Internal::Type::Enum TaggedSymbol = - T.type_alias { T.all(Symbol, FinchAPI::Models::Sandbox::IndividualUpdateResponse::Email::Type) } + T.type_alias do + T.all( + Symbol, + FinchAPI::Models::Sandbox::IndividualUpdateResponse::Email::Type + ) + end OrSymbol = T.type_alias { T.any(Symbol, String) } - WORK = T.let(:work, FinchAPI::Models::Sandbox::IndividualUpdateResponse::Email::Type::TaggedSymbol) + WORK = + T.let( + :work, + FinchAPI::Models::Sandbox::IndividualUpdateResponse::Email::Type::TaggedSymbol + ) PERSONAL = - T.let(:personal, FinchAPI::Models::Sandbox::IndividualUpdateResponse::Email::Type::TaggedSymbol) + T.let( + :personal, + FinchAPI::Models::Sandbox::IndividualUpdateResponse::Email::Type::TaggedSymbol + ) - sig { override.returns(T::Array[FinchAPI::Models::Sandbox::IndividualUpdateResponse::Email::Type::TaggedSymbol]) } - def self.values; end + sig do + override.returns( + T::Array[ + FinchAPI::Models::Sandbox::IndividualUpdateResponse::Email::Type::TaggedSymbol + ] + ) + end + def self.values + end end end @@ -191,11 +287,24 @@ module FinchAPI extend FinchAPI::Internal::Type::Enum TaggedSymbol = - T.type_alias { T.all(Symbol, FinchAPI::Models::Sandbox::IndividualUpdateResponse::Ethnicity) } + T.type_alias do + T.all( + Symbol, + FinchAPI::Models::Sandbox::IndividualUpdateResponse::Ethnicity + ) + end OrSymbol = T.type_alias { T.any(Symbol, String) } - ASIAN = T.let(:asian, FinchAPI::Models::Sandbox::IndividualUpdateResponse::Ethnicity::TaggedSymbol) - WHITE = T.let(:white, 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, @@ -212,14 +321,30 @@ module FinchAPI FinchAPI::Models::Sandbox::IndividualUpdateResponse::Ethnicity::TaggedSymbol ) HISPANIC_OR_LATINO = - T.let(:hispanic_or_latino, FinchAPI::Models::Sandbox::IndividualUpdateResponse::Ethnicity::TaggedSymbol) + 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) + 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) + T.let( + :decline_to_specify, + FinchAPI::Models::Sandbox::IndividualUpdateResponse::Ethnicity::TaggedSymbol + ) - sig { override.returns(T::Array[FinchAPI::Models::Sandbox::IndividualUpdateResponse::Ethnicity::TaggedSymbol]) } - def self.values; end + sig do + override.returns( + T::Array[ + FinchAPI::Models::Sandbox::IndividualUpdateResponse::Ethnicity::TaggedSymbol + ] + ) + end + def self.values + end end # The gender of the individual. @@ -227,62 +352,120 @@ module FinchAPI extend FinchAPI::Internal::Type::Enum TaggedSymbol = - T.type_alias { T.all(Symbol, FinchAPI::Models::Sandbox::IndividualUpdateResponse::Gender) } + T.type_alias do + T.all( + Symbol, + FinchAPI::Models::Sandbox::IndividualUpdateResponse::Gender + ) + end OrSymbol = T.type_alias { T.any(Symbol, String) } - 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) + 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) + T.let( + :decline_to_specify, + FinchAPI::Models::Sandbox::IndividualUpdateResponse::Gender::TaggedSymbol + ) - sig { override.returns(T::Array[FinchAPI::Models::Sandbox::IndividualUpdateResponse::Gender::TaggedSymbol]) } - def self.values; end + sig do + override.returns( + T::Array[ + FinchAPI::Models::Sandbox::IndividualUpdateResponse::Gender::TaggedSymbol + ] + ) + end + def self.values + end end class PhoneNumber < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + sig { returns(T.nilable(String)) } attr_accessor :data - sig { returns(T.nilable(FinchAPI::Models::Sandbox::IndividualUpdateResponse::PhoneNumber::Type::TaggedSymbol)) } + sig do + returns( + T.nilable( + FinchAPI::Models::Sandbox::IndividualUpdateResponse::PhoneNumber::Type::TaggedSymbol + ) + ) + end attr_accessor :type sig do params( data: T.nilable(String), - type: T.nilable(FinchAPI::Models::Sandbox::IndividualUpdateResponse::PhoneNumber::Type::OrSymbol) - ) - .returns(T.attached_class) + type: + T.nilable( + FinchAPI::Models::Sandbox::IndividualUpdateResponse::PhoneNumber::Type::OrSymbol + ) + ).returns(T.attached_class) + end + def self.new(data: nil, type: nil) end - def self.new(data: nil, type: nil); end sig do - override - .returns( - { - data: T.nilable(String), - type: T.nilable(FinchAPI::Models::Sandbox::IndividualUpdateResponse::PhoneNumber::Type::TaggedSymbol) - } - ) + override.returns( + { + data: T.nilable(String), + type: + T.nilable( + FinchAPI::Models::Sandbox::IndividualUpdateResponse::PhoneNumber::Type::TaggedSymbol + ) + } + ) + end + def to_hash end - def to_hash; end module Type extend FinchAPI::Internal::Type::Enum TaggedSymbol = - T.type_alias { T.all(Symbol, FinchAPI::Models::Sandbox::IndividualUpdateResponse::PhoneNumber::Type) } + T.type_alias do + T.all( + Symbol, + FinchAPI::Models::Sandbox::IndividualUpdateResponse::PhoneNumber::Type + ) + end OrSymbol = T.type_alias { T.any(Symbol, String) } - WORK = T.let(:work, FinchAPI::Models::Sandbox::IndividualUpdateResponse::PhoneNumber::Type::TaggedSymbol) + WORK = + T.let( + :work, + FinchAPI::Models::Sandbox::IndividualUpdateResponse::PhoneNumber::Type::TaggedSymbol + ) PERSONAL = - T.let(:personal, FinchAPI::Models::Sandbox::IndividualUpdateResponse::PhoneNumber::Type::TaggedSymbol) + T.let( + :personal, + FinchAPI::Models::Sandbox::IndividualUpdateResponse::PhoneNumber::Type::TaggedSymbol + ) sig do - override - .returns(T::Array[FinchAPI::Models::Sandbox::IndividualUpdateResponse::PhoneNumber::Type::TaggedSymbol]) + override.returns( + T::Array[ + FinchAPI::Models::Sandbox::IndividualUpdateResponse::PhoneNumber::Type::TaggedSymbol + ] + ) + end + def self.values end - def self.values; end end end end diff --git a/rbi/finch_api/models/sandbox/job_create_params.rbi b/rbi/finch_api/models/sandbox/job_create_params.rbi index 97d80c3b..c819c197 100644 --- a/rbi/finch_api/models/sandbox/job_create_params.rbi +++ b/rbi/finch_api/models/sandbox/job_create_params.rbi @@ -7,41 +7,60 @@ module FinchAPI extend FinchAPI::Internal::Type::RequestParameters::Converter include FinchAPI::Internal::Type::RequestParameters + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + # The type of job to start. Currently the only supported type is `data_sync_all` - sig { returns(FinchAPI::Models::Sandbox::JobCreateParams::Type::OrSymbol) } + sig { returns(FinchAPI::Sandbox::JobCreateParams::Type::OrSymbol) } attr_accessor :type sig do params( - type: FinchAPI::Models::Sandbox::JobCreateParams::Type::OrSymbol, - request_options: T.any(FinchAPI::RequestOptions, FinchAPI::Internal::AnyHash) - ) - .returns(T.attached_class) + type: FinchAPI::Sandbox::JobCreateParams::Type::OrSymbol, + request_options: FinchAPI::RequestOptions::OrHash + ).returns(T.attached_class) end def self.new( # The type of job to start. Currently the only supported type is `data_sync_all` type:, request_options: {} - ); end + ) + end + sig do - override - .returns( - {type: FinchAPI::Models::Sandbox::JobCreateParams::Type::OrSymbol, request_options: FinchAPI::RequestOptions} - ) + override.returns( + { + type: FinchAPI::Sandbox::JobCreateParams::Type::OrSymbol, + request_options: FinchAPI::RequestOptions + } + ) + end + def to_hash end - def to_hash; end # The type of job to start. Currently the only supported type is `data_sync_all` module Type extend FinchAPI::Internal::Type::Enum - TaggedSymbol = T.type_alias { T.all(Symbol, FinchAPI::Models::Sandbox::JobCreateParams::Type) } + TaggedSymbol = + T.type_alias do + T.all(Symbol, FinchAPI::Sandbox::JobCreateParams::Type) + end OrSymbol = T.type_alias { T.any(Symbol, String) } - DATA_SYNC_ALL = T.let(:data_sync_all, FinchAPI::Models::Sandbox::JobCreateParams::Type::TaggedSymbol) + DATA_SYNC_ALL = + T.let( + :data_sync_all, + FinchAPI::Sandbox::JobCreateParams::Type::TaggedSymbol + ) - sig { override.returns(T::Array[FinchAPI::Models::Sandbox::JobCreateParams::Type::TaggedSymbol]) } - def self.values; end + sig do + override.returns( + T::Array[FinchAPI::Sandbox::JobCreateParams::Type::TaggedSymbol] + ) + end + def self.values + end end end end diff --git a/rbi/finch_api/models/sandbox/job_create_response.rbi b/rbi/finch_api/models/sandbox/job_create_response.rbi index d9319124..25004398 100644 --- a/rbi/finch_api/models/sandbox/job_create_response.rbi +++ b/rbi/finch_api/models/sandbox/job_create_response.rbi @@ -4,6 +4,9 @@ module FinchAPI module Models module Sandbox class JobCreateResponse < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + # The number of allowed refreshes per hour (per hour, fixed window) sig { returns(Integer) } attr_accessor :allowed_refreshes @@ -21,8 +24,12 @@ module FinchAPI attr_accessor :remaining_refreshes sig do - params(allowed_refreshes: Integer, job_id: String, job_url: String, remaining_refreshes: Integer) - .returns(T.attached_class) + params( + allowed_refreshes: Integer, + job_id: String, + job_url: String, + remaining_refreshes: Integer + ).returns(T.attached_class) end def self.new( # The number of allowed refreshes per hour (per hour, fixed window) @@ -33,17 +40,21 @@ module FinchAPI job_url:, # The number of remaining refreshes available (per hour, fixed window) remaining_refreshes: - ); end + ) + end + sig do - override - .returns({ - allowed_refreshes: Integer, - job_id: String, - job_url: String, - remaining_refreshes: Integer - }) + override.returns( + { + allowed_refreshes: Integer, + job_id: String, + job_url: String, + remaining_refreshes: Integer + } + ) + end + def to_hash end - def to_hash; end end end end diff --git a/rbi/finch_api/models/sandbox/jobs/configuration_retrieve_params.rbi b/rbi/finch_api/models/sandbox/jobs/configuration_retrieve_params.rbi index 2c437639..60578aec 100644 --- a/rbi/finch_api/models/sandbox/jobs/configuration_retrieve_params.rbi +++ b/rbi/finch_api/models/sandbox/jobs/configuration_retrieve_params.rbi @@ -8,14 +8,22 @@ module FinchAPI extend FinchAPI::Internal::Type::RequestParameters::Converter include FinchAPI::Internal::Type::RequestParameters + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + sig do - params(request_options: T.any(FinchAPI::RequestOptions, FinchAPI::Internal::AnyHash)) - .returns(T.attached_class) + params(request_options: FinchAPI::RequestOptions::OrHash).returns( + T.attached_class + ) + end + def self.new(request_options: {}) end - def self.new(request_options: {}); end - sig { override.returns({request_options: FinchAPI::RequestOptions}) } - def to_hash; end + sig do + override.returns({ request_options: FinchAPI::RequestOptions }) + end + def to_hash + end end end end diff --git a/rbi/finch_api/models/sandbox/jobs/configuration_retrieve_response.rbi b/rbi/finch_api/models/sandbox/jobs/configuration_retrieve_response.rbi index cdca13c5..118c72ff 100644 --- a/rbi/finch_api/models/sandbox/jobs/configuration_retrieve_response.rbi +++ b/rbi/finch_api/models/sandbox/jobs/configuration_retrieve_response.rbi @@ -6,7 +6,9 @@ module FinchAPI module Jobs ConfigurationRetrieveResponse = T.let( - FinchAPI::Internal::Type::ArrayOf[FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration], + FinchAPI::Internal::Type::ArrayOf[ + FinchAPI::Sandbox::Jobs::SandboxJobConfiguration + ], FinchAPI::Internal::Type::Converter ) end diff --git a/rbi/finch_api/models/sandbox/jobs/configuration_update_params.rbi b/rbi/finch_api/models/sandbox/jobs/configuration_update_params.rbi index 2770373e..af721a6f 100644 --- a/rbi/finch_api/models/sandbox/jobs/configuration_update_params.rbi +++ b/rbi/finch_api/models/sandbox/jobs/configuration_update_params.rbi @@ -8,14 +8,22 @@ module FinchAPI extend FinchAPI::Internal::Type::RequestParameters::Converter include FinchAPI::Internal::Type::RequestParameters + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + sig do - params(request_options: T.any(FinchAPI::RequestOptions, FinchAPI::Internal::AnyHash)) - .returns(T.attached_class) + params(request_options: FinchAPI::RequestOptions::OrHash).returns( + T.attached_class + ) + end + def self.new(request_options: {}) end - def self.new(request_options: {}); end - sig { override.returns({request_options: FinchAPI::RequestOptions}) } - def to_hash; end + sig do + override.returns({ request_options: FinchAPI::RequestOptions }) + end + def to_hash + end end end end diff --git a/rbi/finch_api/models/sandbox/jobs/sandbox_job_configuration.rbi b/rbi/finch_api/models/sandbox/jobs/sandbox_job_configuration.rbi index 75f49956..14ec6ae3 100644 --- a/rbi/finch_api/models/sandbox/jobs/sandbox_job_configuration.rbi +++ b/rbi/finch_api/models/sandbox/jobs/sandbox_job_configuration.rbi @@ -5,75 +5,118 @@ module FinchAPI module Sandbox module Jobs class SandboxJobConfiguration < FinchAPI::Internal::Type::BaseModel - sig { returns(FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration::CompletionStatus::TaggedSymbol) } + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + + sig do + returns( + FinchAPI::Sandbox::Jobs::SandboxJobConfiguration::CompletionStatus::TaggedSymbol + ) + end attr_accessor :completion_status - sig { returns(FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration::Type::TaggedSymbol) } + sig do + returns( + FinchAPI::Sandbox::Jobs::SandboxJobConfiguration::Type::TaggedSymbol + ) + end attr_accessor :type sig do params( - completion_status: FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration::CompletionStatus::OrSymbol, - type: FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration::Type::OrSymbol - ) - .returns(T.attached_class) + completion_status: + FinchAPI::Sandbox::Jobs::SandboxJobConfiguration::CompletionStatus::OrSymbol, + type: + FinchAPI::Sandbox::Jobs::SandboxJobConfiguration::Type::OrSymbol + ).returns(T.attached_class) + end + def self.new(completion_status:, type:) end - def self.new(completion_status:, type:); end sig do - override - .returns( - { - completion_status: FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration::CompletionStatus::TaggedSymbol, - type: FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration::Type::TaggedSymbol - } - ) + override.returns( + { + completion_status: + FinchAPI::Sandbox::Jobs::SandboxJobConfiguration::CompletionStatus::TaggedSymbol, + type: + FinchAPI::Sandbox::Jobs::SandboxJobConfiguration::Type::TaggedSymbol + } + ) + end + def to_hash end - def to_hash; end module CompletionStatus extend FinchAPI::Internal::Type::Enum TaggedSymbol = - T.type_alias { T.all(Symbol, FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration::CompletionStatus) } + T.type_alias do + T.all( + Symbol, + FinchAPI::Sandbox::Jobs::SandboxJobConfiguration::CompletionStatus + ) + end OrSymbol = T.type_alias { T.any(Symbol, String) } COMPLETE = - T.let(:complete, FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration::CompletionStatus::TaggedSymbol) + T.let( + :complete, + FinchAPI::Sandbox::Jobs::SandboxJobConfiguration::CompletionStatus::TaggedSymbol + ) REAUTH_ERROR = T.let( :reauth_error, - FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration::CompletionStatus::TaggedSymbol + FinchAPI::Sandbox::Jobs::SandboxJobConfiguration::CompletionStatus::TaggedSymbol ) PERMISSIONS_ERROR = T.let( :permissions_error, - FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration::CompletionStatus::TaggedSymbol + FinchAPI::Sandbox::Jobs::SandboxJobConfiguration::CompletionStatus::TaggedSymbol ) ERROR = - T.let(:error, FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration::CompletionStatus::TaggedSymbol) + T.let( + :error, + FinchAPI::Sandbox::Jobs::SandboxJobConfiguration::CompletionStatus::TaggedSymbol + ) sig do - override - .returns( - T::Array[FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration::CompletionStatus::TaggedSymbol] - ) + override.returns( + T::Array[ + FinchAPI::Sandbox::Jobs::SandboxJobConfiguration::CompletionStatus::TaggedSymbol + ] + ) + end + def self.values end - def self.values; end end module Type extend FinchAPI::Internal::Type::Enum TaggedSymbol = - T.type_alias { T.all(Symbol, FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration::Type) } + T.type_alias do + T.all( + Symbol, + FinchAPI::Sandbox::Jobs::SandboxJobConfiguration::Type + ) + end OrSymbol = T.type_alias { T.any(Symbol, String) } DATA_SYNC_ALL = - T.let(:data_sync_all, FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration::Type::TaggedSymbol) + T.let( + :data_sync_all, + FinchAPI::Sandbox::Jobs::SandboxJobConfiguration::Type::TaggedSymbol + ) - sig { override.returns(T::Array[FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration::Type::TaggedSymbol]) } - def self.values; end + sig do + override.returns( + T::Array[ + FinchAPI::Sandbox::Jobs::SandboxJobConfiguration::Type::TaggedSymbol + ] + ) + end + def self.values + end end end end diff --git a/rbi/finch_api/models/sandbox/payment_create_params.rbi b/rbi/finch_api/models/sandbox/payment_create_params.rbi index 0475f5b9..c7abb730 100644 --- a/rbi/finch_api/models/sandbox/payment_create_params.rbi +++ b/rbi/finch_api/models/sandbox/payment_create_params.rbi @@ -7,20 +7,31 @@ module FinchAPI extend FinchAPI::Internal::Type::RequestParameters::Converter include FinchAPI::Internal::Type::RequestParameters + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + sig { returns(T.nilable(String)) } attr_reader :end_date sig { params(end_date: String).void } attr_writer :end_date - sig { returns(T.nilable(T::Array[FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement])) } + sig do + returns( + T.nilable( + T::Array[FinchAPI::Sandbox::PaymentCreateParams::PayStatement] + ) + ) + end attr_reader :pay_statements sig do params( - pay_statements: T::Array[T.any(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement, FinchAPI::Internal::AnyHash)] - ) - .void + pay_statements: + T::Array[ + FinchAPI::Sandbox::PaymentCreateParams::PayStatement::OrHash + ] + ).void end attr_writer :pay_statements @@ -33,32 +44,50 @@ module FinchAPI sig do params( end_date: String, - pay_statements: T::Array[T.any(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement, FinchAPI::Internal::AnyHash)], + pay_statements: + T::Array[ + FinchAPI::Sandbox::PaymentCreateParams::PayStatement::OrHash + ], start_date: String, - request_options: T.any(FinchAPI::RequestOptions, FinchAPI::Internal::AnyHash) - ) - .returns(T.attached_class) + request_options: FinchAPI::RequestOptions::OrHash + ).returns(T.attached_class) + end + def self.new( + end_date: nil, + pay_statements: nil, + start_date: nil, + request_options: {} + ) end - def self.new(end_date: nil, pay_statements: nil, start_date: nil, request_options: {}); end sig do - override - .returns( - { - end_date: String, - pay_statements: T::Array[FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement], - start_date: String, - request_options: FinchAPI::RequestOptions - } - ) + override.returns( + { + end_date: String, + pay_statements: + T::Array[FinchAPI::Sandbox::PaymentCreateParams::PayStatement], + start_date: String, + request_options: FinchAPI::RequestOptions + } + ) + end + def to_hash end - def to_hash; end class PayStatement < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + # 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)]) + T.nilable( + T::Array[ + T.nilable( + FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Earning + ) + ] + ) ) end attr_accessor :earnings @@ -67,7 +96,11 @@ module FinchAPI sig do returns( T.nilable( - T::Array[T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction)] + T::Array[ + T.nilable( + FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction + ) + ] ) ) end @@ -76,16 +109,20 @@ module FinchAPI sig do returns( T.nilable( - T::Array[T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution)] + T::Array[ + T.nilable( + FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution + ) + ] ) ) end attr_accessor :employer_contributions - sig { returns(T.nilable(FinchAPI::Models::Money)) } + sig { returns(T.nilable(FinchAPI::Money)) } attr_reader :gross_pay - sig { params(gross_pay: T.nilable(T.any(FinchAPI::Models::Money, FinchAPI::Internal::AnyHash))).void } + sig { params(gross_pay: T.nilable(FinchAPI::Money::OrHash)).void } attr_writer :gross_pay # A stable Finch `id` (UUID v4) for an individual in the company @@ -95,18 +132,34 @@ module FinchAPI sig { params(individual_id: String).void } attr_writer :individual_id - sig { returns(T.nilable(FinchAPI::Models::Money)) } + sig { returns(T.nilable(FinchAPI::Money)) } attr_reader :net_pay - sig { params(net_pay: T.nilable(T.any(FinchAPI::Models::Money, FinchAPI::Internal::AnyHash))).void } + sig { params(net_pay: T.nilable(FinchAPI::Money::OrHash)).void } attr_writer :net_pay # The payment method. - sig { returns(T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::PaymentMethod::OrSymbol)) } + sig do + returns( + T.nilable( + FinchAPI::Sandbox::PaymentCreateParams::PayStatement::PaymentMethod::OrSymbol + ) + ) + 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)])) } + sig do + returns( + T.nilable( + T::Array[ + T.nilable( + FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Tax + ) + ] + ) + ) + end attr_accessor :taxes # The number of hours worked for this pay period @@ -114,53 +167,62 @@ module FinchAPI 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)) } + sig do + returns( + T.nilable( + FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Type::OrSymbol + ) + ) + end attr_accessor :type sig do params( - earnings: T.nilable( - T::Array[ - T.nilable( - T.any(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning, FinchAPI::Internal::AnyHash) - ) - ] - ), - employee_deductions: T.nilable( - T::Array[ - T.nilable( - T.any( - FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction, - FinchAPI::Internal::AnyHash + earnings: + T.nilable( + T::Array[ + T.nilable( + FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Earning::OrHash ) - ) - ] - ), - employer_contributions: T.nilable( - T::Array[ - T.nilable( - T.any( - FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution, - FinchAPI::Internal::AnyHash + ] + ), + employee_deductions: + T.nilable( + T::Array[ + T.nilable( + FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::OrHash ) - ) - ] - ), - gross_pay: T.nilable(T.any(FinchAPI::Models::Money, FinchAPI::Internal::AnyHash)), + ] + ), + employer_contributions: + T.nilable( + T::Array[ + T.nilable( + FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::OrHash + ) + ] + ), + gross_pay: T.nilable(FinchAPI::Money::OrHash), individual_id: String, - net_pay: T.nilable(T.any(FinchAPI::Models::Money, FinchAPI::Internal::AnyHash)), - payment_method: T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::PaymentMethod::OrSymbol), - taxes: T.nilable( - T::Array[ - T.nilable( - T.any(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax, FinchAPI::Internal::AnyHash) - ) - ] - ), + net_pay: T.nilable(FinchAPI::Money::OrHash), + payment_method: + T.nilable( + FinchAPI::Sandbox::PaymentCreateParams::PayStatement::PaymentMethod::OrSymbol + ), + taxes: + T.nilable( + T::Array[ + T.nilable( + FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Tax::OrHash + ) + ] + ), total_hours: T.nilable(Float), - type: T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Type::OrSymbol) - ) - .returns(T.attached_class) + type: + T.nilable( + FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Type::OrSymbol + ) + ).returns(T.attached_class) end def self.new( # The array of earnings objects associated with this pay statement @@ -180,48 +242,86 @@ module FinchAPI total_hours: nil, # The type of the payment associated with the pay statement. type: nil - ); end + ) + end + sig do - override - .returns( - { - earnings: T.nilable(T::Array[T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning)]), - employee_deductions: T.nilable( - T::Array[T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction)] + override.returns( + { + earnings: + T.nilable( + T::Array[ + T.nilable( + FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Earning + ) + ] ), - employer_contributions: T.nilable( - T::Array[T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution)] + employee_deductions: + T.nilable( + T::Array[ + T.nilable( + FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction + ) + ] ), - gross_pay: T.nilable(FinchAPI::Models::Money), - individual_id: String, - net_pay: T.nilable(FinchAPI::Models::Money), - 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(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Type::OrSymbol) - } - ) + employer_contributions: + T.nilable( + T::Array[ + T.nilable( + FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution + ) + ] + ), + gross_pay: T.nilable(FinchAPI::Money), + individual_id: String, + net_pay: T.nilable(FinchAPI::Money), + payment_method: + T.nilable( + FinchAPI::Sandbox::PaymentCreateParams::PayStatement::PaymentMethod::OrSymbol + ), + taxes: + T.nilable( + T::Array[ + T.nilable( + FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Tax + ) + ] + ), + total_hours: T.nilable(Float), + type: + T.nilable( + FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Type::OrSymbol + ) + } + ) + end + def to_hash end - def to_hash; end class Earning < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + # The earnings amount in cents. sig { returns(T.nilable(Integer)) } attr_accessor :amount - sig { returns(T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Attributes)) } + sig do + returns( + T.nilable( + FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Earning::Attributes + ) + ) + end attr_reader :attributes sig do params( - attributes: T.nilable( - T.any( - FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Attributes, - FinchAPI::Internal::AnyHash + attributes: + T.nilable( + FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Earning::Attributes::OrHash ) - ) - ) - .void + ).void end attr_writer :attributes @@ -239,24 +339,30 @@ module FinchAPI attr_accessor :name # The type of earning. - sig { returns(T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Type::OrSymbol)) } + sig do + returns( + T.nilable( + FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Earning::Type::OrSymbol + ) + ) + end attr_accessor :type sig do params( amount: T.nilable(Integer), - attributes: T.nilable( - T.any( - FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Attributes, - FinchAPI::Internal::AnyHash - ) - ), + attributes: + T.nilable( + FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Earning::Attributes::OrHash + ), currency: T.nilable(String), hours: T.nilable(Float), name: T.nilable(String), - type: T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Type::OrSymbol) - ) - .returns(T.attached_class) + type: + T.nilable( + FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Earning::Type::OrSymbol + ) + ).returns(T.attached_class) end def self.new( # The earnings amount in cents. @@ -271,79 +377,110 @@ module FinchAPI name: nil, # The type of earning. type: nil - ); end + ) + end + sig do - override - .returns( - { - amount: T.nilable(Integer), - attributes: T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Attributes), - currency: T.nilable(String), - hours: T.nilable(Float), - name: T.nilable(String), - type: T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Type::OrSymbol) - } - ) + override.returns( + { + amount: T.nilable(Integer), + attributes: + T.nilable( + FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Earning::Attributes + ), + currency: T.nilable(String), + hours: T.nilable(Float), + name: T.nilable(String), + type: + T.nilable( + FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Earning::Type::OrSymbol + ) + } + ) + end + def to_hash end - def to_hash; end class Attributes < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + sig do returns( - T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Attributes::Metadata) + T.nilable( + FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Earning::Attributes::Metadata + ) ) end attr_reader :metadata sig do params( - metadata: T.any( - FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Attributes::Metadata, - FinchAPI::Internal::AnyHash - ) - ) - .void + metadata: + FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Earning::Attributes::Metadata::OrHash + ).void end attr_writer :metadata sig do params( - metadata: T.any( - FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Attributes::Metadata, - FinchAPI::Internal::AnyHash - ) - ) - .returns(T.attached_class) + metadata: + FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Earning::Attributes::Metadata::OrHash + ).returns(T.attached_class) + end + def self.new(metadata: nil) end - def self.new(metadata: nil); end sig do - override - .returns( - {metadata: FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Attributes::Metadata} - ) + override.returns( + { + metadata: + FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Earning::Attributes::Metadata + } + ) + end + def to_hash end - def to_hash; end class Metadata < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any(T.self_type, FinchAPI::Internal::AnyHash) + end + # 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])) } + sig do + returns(T.nilable(T::Hash[Symbol, T.nilable(T.anything)])) + end attr_reader :metadata - sig { params(metadata: T::Hash[Symbol, T.anything]).void } + sig do + params(metadata: T::Hash[Symbol, T.nilable(T.anything)]).void + end attr_writer :metadata - sig { params(metadata: T::Hash[Symbol, T.anything]).returns(T.attached_class) } + sig do + params( + metadata: T::Hash[Symbol, T.nilable(T.anything)] + ).returns(T.attached_class) + end def self.new( # 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.). metadata: nil - ); end - sig { override.returns({metadata: T::Hash[Symbol, T.anything]}) } - def to_hash; end + ) + end + + sig do + override.returns( + { metadata: T::Hash[Symbol, T.nilable(T.anything)] } + ) + end + def to_hash + end end end @@ -352,83 +489,116 @@ module FinchAPI extend FinchAPI::Internal::Type::Enum TaggedSymbol = - T.type_alias { T.all(Symbol, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Type) } + T.type_alias do + T.all( + Symbol, + FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Earning::Type + ) + end OrSymbol = T.type_alias { T.any(Symbol, String) } SALARY = - T.let(:salary, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Type::TaggedSymbol) + T.let( + :salary, + FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Earning::Type::TaggedSymbol + ) WAGE = - T.let(:wage, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Type::TaggedSymbol) + T.let( + :wage, + FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Earning::Type::TaggedSymbol + ) REIMBURSEMENT = T.let( :reimbursement, - FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Type::TaggedSymbol + FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Earning::Type::TaggedSymbol ) OVERTIME = T.let( :overtime, - FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Type::TaggedSymbol + FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Earning::Type::TaggedSymbol ) SEVERANCE = T.let( :severance, - FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Type::TaggedSymbol + FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Earning::Type::TaggedSymbol ) DOUBLE_OVERTIME = T.let( :double_overtime, - FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Type::TaggedSymbol + FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Earning::Type::TaggedSymbol ) PTO = - T.let(:pto, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Type::TaggedSymbol) + T.let( + :pto, + FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Earning::Type::TaggedSymbol + ) SICK = - T.let(:sick, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Type::TaggedSymbol) + T.let( + :sick, + FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Earning::Type::TaggedSymbol + ) BONUS = - T.let(:bonus, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Type::TaggedSymbol) + T.let( + :bonus, + FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Earning::Type::TaggedSymbol + ) COMMISSION = T.let( :commission, - FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Type::TaggedSymbol + FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Earning::Type::TaggedSymbol ) TIPS = - T.let(:tips, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Type::TaggedSymbol) + T.let( + :tips, + FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Earning::Type::TaggedSymbol + ) TYPE_1099 = - T.let(:"1099", FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Type::TaggedSymbol) + T.let( + :"1099", + FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Earning::Type::TaggedSymbol + ) OTHER = - T.let(:other, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Type::TaggedSymbol) + T.let( + :other, + FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Earning::Type::TaggedSymbol + ) sig do - override - .returns( - T::Array[FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Type::TaggedSymbol] - ) + override.returns( + T::Array[ + FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Earning::Type::TaggedSymbol + ] + ) + end + def self.values end - def self.values; end end end class EmployeeDeduction < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + # The deduction amount in cents. sig { returns(T.nilable(Integer)) } attr_accessor :amount sig do returns( - T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Attributes) + T.nilable( + FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Attributes + ) ) end attr_reader :attributes sig do params( - attributes: T.nilable( - T.any( - FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Attributes, - FinchAPI::Internal::AnyHash + attributes: + T.nilable( + FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Attributes::OrHash ) - ) - ) - .void + ).void end attr_writer :attributes @@ -445,24 +615,21 @@ module FinchAPI attr_accessor :pre_tax # Type of benefit. - sig { returns(T.nilable(FinchAPI::Models::HRIS::BenefitType::OrSymbol)) } + sig { returns(T.nilable(FinchAPI::HRIS::BenefitType::OrSymbol)) } attr_accessor :type sig do params( amount: T.nilable(Integer), - attributes: T.nilable( - T.any( - FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Attributes, - FinchAPI::Internal::AnyHash - ) - ), + attributes: + T.nilable( + FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Attributes::OrHash + ), currency: T.nilable(String), name: T.nilable(String), pre_tax: T.nilable(T::Boolean), - type: T.nilable(FinchAPI::Models::HRIS::BenefitType::OrSymbol) - ) - .returns(T.attached_class) + type: T.nilable(FinchAPI::HRIS::BenefitType::OrSymbol) + ).returns(T.attached_class) end def self.new( # The deduction amount in cents. @@ -476,27 +643,35 @@ module FinchAPI pre_tax: nil, # Type of benefit. type: nil - ); end + ) + end + sig do - override - .returns( - { - amount: T.nilable(Integer), - attributes: T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Attributes), - currency: T.nilable(String), - name: T.nilable(String), - pre_tax: T.nilable(T::Boolean), - type: T.nilable(FinchAPI::Models::HRIS::BenefitType::OrSymbol) - } - ) + override.returns( + { + amount: T.nilable(Integer), + attributes: + T.nilable( + FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Attributes + ), + currency: T.nilable(String), + name: T.nilable(String), + pre_tax: T.nilable(T::Boolean), + type: T.nilable(FinchAPI::HRIS::BenefitType::OrSymbol) + } + ) + end + def to_hash end - def to_hash; end class Attributes < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + sig do returns( T.nilable( - FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Attributes::Metadata + FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Attributes::Metadata ) ) end @@ -504,81 +679,99 @@ module FinchAPI sig do params( - metadata: T.any( - FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Attributes::Metadata, - FinchAPI::Internal::AnyHash - ) - ) - .void + metadata: + FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Attributes::Metadata::OrHash + ).void end attr_writer :metadata sig do params( - metadata: T.any( - FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Attributes::Metadata, - FinchAPI::Internal::AnyHash - ) - ) - .returns(T.attached_class) + metadata: + FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Attributes::Metadata::OrHash + ).returns(T.attached_class) + end + def self.new(metadata: nil) end - def self.new(metadata: nil); end sig do - override - .returns( - { - metadata: FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Attributes::Metadata - } - ) + override.returns( + { + metadata: + FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Attributes::Metadata + } + ) + end + def to_hash end - def to_hash; end class Metadata < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any(T.self_type, FinchAPI::Internal::AnyHash) + end + # 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])) } + sig do + returns(T.nilable(T::Hash[Symbol, T.nilable(T.anything)])) + end attr_reader :metadata - sig { params(metadata: T::Hash[Symbol, T.anything]).void } + sig do + params(metadata: T::Hash[Symbol, T.nilable(T.anything)]).void + end attr_writer :metadata - sig { params(metadata: T::Hash[Symbol, T.anything]).returns(T.attached_class) } + sig do + params( + metadata: T::Hash[Symbol, T.nilable(T.anything)] + ).returns(T.attached_class) + end def self.new( # 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.). metadata: nil - ); end - sig { override.returns({metadata: T::Hash[Symbol, T.anything]}) } - def to_hash; end + ) + end + + sig do + override.returns( + { metadata: T::Hash[Symbol, T.nilable(T.anything)] } + ) + end + def to_hash + end end end end class EmployerContribution < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + # The contribution amount in cents. sig { returns(T.nilable(Integer)) } attr_accessor :amount sig do returns( - T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Attributes) + T.nilable( + FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Attributes + ) ) end attr_reader :attributes sig do params( - attributes: T.nilable( - T.any( - FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Attributes, - FinchAPI::Internal::AnyHash + attributes: + T.nilable( + FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Attributes::OrHash ) - ) - ) - .void + ).void end attr_writer :attributes @@ -591,23 +784,20 @@ module FinchAPI attr_accessor :name # Type of benefit. - sig { returns(T.nilable(FinchAPI::Models::HRIS::BenefitType::OrSymbol)) } + sig { returns(T.nilable(FinchAPI::HRIS::BenefitType::OrSymbol)) } attr_accessor :type sig do params( amount: T.nilable(Integer), - attributes: T.nilable( - T.any( - FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Attributes, - FinchAPI::Internal::AnyHash - ) - ), + attributes: + T.nilable( + FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Attributes::OrHash + ), currency: T.nilable(String), name: T.nilable(String), - type: T.nilable(FinchAPI::Models::HRIS::BenefitType::OrSymbol) - ) - .returns(T.attached_class) + type: T.nilable(FinchAPI::HRIS::BenefitType::OrSymbol) + ).returns(T.attached_class) end def self.new( # The contribution amount in cents. @@ -619,26 +809,34 @@ module FinchAPI name: nil, # Type of benefit. type: nil - ); end + ) + end + sig do - override - .returns( - { - amount: T.nilable(Integer), - attributes: T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Attributes), - currency: T.nilable(String), - name: T.nilable(String), - type: T.nilable(FinchAPI::Models::HRIS::BenefitType::OrSymbol) - } - ) + override.returns( + { + amount: T.nilable(Integer), + attributes: + T.nilable( + FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Attributes + ), + currency: T.nilable(String), + name: T.nilable(String), + type: T.nilable(FinchAPI::HRIS::BenefitType::OrSymbol) + } + ) + end + def to_hash end - def to_hash; end class Attributes < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + sig do returns( T.nilable( - FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Attributes::Metadata + FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Attributes::Metadata ) ) end @@ -646,55 +844,71 @@ module FinchAPI sig do params( - metadata: T.any( - FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Attributes::Metadata, - FinchAPI::Internal::AnyHash - ) - ) - .void + metadata: + FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Attributes::Metadata::OrHash + ).void end attr_writer :metadata sig do params( - metadata: T.any( - FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Attributes::Metadata, - FinchAPI::Internal::AnyHash - ) - ) - .returns(T.attached_class) + metadata: + FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Attributes::Metadata::OrHash + ).returns(T.attached_class) + end + def self.new(metadata: nil) end - def self.new(metadata: nil); end sig do - override - .returns( - { - metadata: FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Attributes::Metadata - } - ) + override.returns( + { + metadata: + FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Attributes::Metadata + } + ) + end + def to_hash end - def to_hash; end class Metadata < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any(T.self_type, FinchAPI::Internal::AnyHash) + end + # 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])) } + sig do + returns(T.nilable(T::Hash[Symbol, T.nilable(T.anything)])) + end attr_reader :metadata - sig { params(metadata: T::Hash[Symbol, T.anything]).void } + sig do + params(metadata: T::Hash[Symbol, T.nilable(T.anything)]).void + end attr_writer :metadata - sig { params(metadata: T::Hash[Symbol, T.anything]).returns(T.attached_class) } + sig do + params( + metadata: T::Hash[Symbol, T.nilable(T.anything)] + ).returns(T.attached_class) + end def self.new( # 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.). metadata: nil - ); end - sig { override.returns({metadata: T::Hash[Symbol, T.anything]}) } - def to_hash; end + ) + end + + sig do + override.returns( + { metadata: T::Hash[Symbol, T.nilable(T.anything)] } + ) + end + def to_hash + end end end end @@ -704,44 +918,60 @@ module FinchAPI extend FinchAPI::Internal::Type::Enum TaggedSymbol = - T.type_alias { T.all(Symbol, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::PaymentMethod) } + T.type_alias do + T.all( + Symbol, + FinchAPI::Sandbox::PaymentCreateParams::PayStatement::PaymentMethod + ) + end OrSymbol = T.type_alias { T.any(Symbol, String) } CHECK = - T.let(:check, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::PaymentMethod::TaggedSymbol) + T.let( + :check, + FinchAPI::Sandbox::PaymentCreateParams::PayStatement::PaymentMethod::TaggedSymbol + ) DIRECT_DEPOSIT = T.let( :direct_deposit, - FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::PaymentMethod::TaggedSymbol + FinchAPI::Sandbox::PaymentCreateParams::PayStatement::PaymentMethod::TaggedSymbol ) sig do - override - .returns( - T::Array[FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::PaymentMethod::TaggedSymbol] - ) + override.returns( + T::Array[ + FinchAPI::Sandbox::PaymentCreateParams::PayStatement::PaymentMethod::TaggedSymbol + ] + ) + end + def self.values end - def self.values; end end class Tax < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + # The tax amount in cents. sig { returns(T.nilable(Integer)) } attr_accessor :amount - sig { returns(T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::Attributes)) } + sig do + returns( + T.nilable( + FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Tax::Attributes + ) + ) + end attr_reader :attributes sig do params( - attributes: T.nilable( - T.any( - FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::Attributes, - FinchAPI::Internal::AnyHash + attributes: + T.nilable( + FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Tax::Attributes::OrHash ) - ) - ) - .void + ).void end attr_writer :attributes @@ -758,24 +988,30 @@ module FinchAPI attr_accessor :name # The type of taxes. - sig { returns(T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::Type::OrSymbol)) } + sig do + returns( + T.nilable( + FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Tax::Type::OrSymbol + ) + ) + end attr_accessor :type sig do params( amount: T.nilable(Integer), - attributes: T.nilable( - T.any( - FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::Attributes, - FinchAPI::Internal::AnyHash - ) - ), + attributes: + T.nilable( + FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Tax::Attributes::OrHash + ), currency: T.nilable(String), employer: T.nilable(T::Boolean), name: T.nilable(String), - type: T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::Type::OrSymbol) - ) - .returns(T.attached_class) + type: + T.nilable( + FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Tax::Type::OrSymbol + ) + ).returns(T.attached_class) end def self.new( # The tax amount in cents. @@ -789,79 +1025,110 @@ module FinchAPI name: nil, # The type of taxes. type: nil - ); end + ) + end + sig do - override - .returns( - { - amount: T.nilable(Integer), - attributes: T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::Attributes), - currency: T.nilable(String), - employer: T.nilable(T::Boolean), - name: T.nilable(String), - type: T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::Type::OrSymbol) - } - ) + override.returns( + { + amount: T.nilable(Integer), + attributes: + T.nilable( + FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Tax::Attributes + ), + currency: T.nilable(String), + employer: T.nilable(T::Boolean), + name: T.nilable(String), + type: + T.nilable( + FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Tax::Type::OrSymbol + ) + } + ) + end + def to_hash end - def to_hash; end class Attributes < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + sig do returns( - T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::Attributes::Metadata) + T.nilable( + FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Tax::Attributes::Metadata + ) ) end attr_reader :metadata sig do params( - metadata: T.any( - FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::Attributes::Metadata, - FinchAPI::Internal::AnyHash - ) - ) - .void + metadata: + FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Tax::Attributes::Metadata::OrHash + ).void end attr_writer :metadata sig do params( - metadata: T.any( - FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::Attributes::Metadata, - FinchAPI::Internal::AnyHash - ) - ) - .returns(T.attached_class) + metadata: + FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Tax::Attributes::Metadata::OrHash + ).returns(T.attached_class) + end + def self.new(metadata: nil) end - def self.new(metadata: nil); end sig do - override - .returns( - {metadata: FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::Attributes::Metadata} - ) + override.returns( + { + metadata: + FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Tax::Attributes::Metadata + } + ) + end + def to_hash end - def to_hash; end class Metadata < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any(T.self_type, FinchAPI::Internal::AnyHash) + end + # 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])) } + sig do + returns(T.nilable(T::Hash[Symbol, T.nilable(T.anything)])) + end attr_reader :metadata - sig { params(metadata: T::Hash[Symbol, T.anything]).void } + sig do + params(metadata: T::Hash[Symbol, T.nilable(T.anything)]).void + end attr_writer :metadata - sig { params(metadata: T::Hash[Symbol, T.anything]).returns(T.attached_class) } + sig do + params( + metadata: T::Hash[Symbol, T.nilable(T.anything)] + ).returns(T.attached_class) + end def self.new( # 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.). metadata: nil - ); end - sig { override.returns({metadata: T::Hash[Symbol, T.anything]}) } - def to_hash; end + ) + end + + sig do + override.returns( + { metadata: T::Hash[Symbol, T.nilable(T.anything)] } + ) + end + def to_hash + end end end @@ -870,23 +1137,44 @@ module FinchAPI extend FinchAPI::Internal::Type::Enum TaggedSymbol = - T.type_alias { T.all(Symbol, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::Type) } + T.type_alias do + T.all( + Symbol, + FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Tax::Type + ) + end OrSymbol = T.type_alias { T.any(Symbol, String) } STATE = - T.let(:state, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::Type::TaggedSymbol) + T.let( + :state, + FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Tax::Type::TaggedSymbol + ) FEDERAL = - T.let(:federal, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::Type::TaggedSymbol) + T.let( + :federal, + FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Tax::Type::TaggedSymbol + ) LOCAL = - T.let(:local, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::Type::TaggedSymbol) + T.let( + :local, + FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Tax::Type::TaggedSymbol + ) FICA = - T.let(:fica, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::Type::TaggedSymbol) + T.let( + :fica, + FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Tax::Type::TaggedSymbol + ) sig do - override - .returns(T::Array[FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::Type::TaggedSymbol]) + override.returns( + T::Array[ + FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Tax::Type::TaggedSymbol + ] + ) + end + def self.values end - def self.values; end end end @@ -895,24 +1183,39 @@ module FinchAPI extend FinchAPI::Internal::Type::Enum TaggedSymbol = - T.type_alias { T.all(Symbol, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Type) } + T.type_alias do + T.all( + Symbol, + FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Type + ) + end OrSymbol = T.type_alias { T.any(Symbol, String) } REGULAR_PAYROLL = - T.let(:regular_payroll, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Type::TaggedSymbol) + T.let( + :regular_payroll, + FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Type::TaggedSymbol + ) OFF_CYCLE_PAYROLL = T.let( :off_cycle_payroll, - FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Type::TaggedSymbol + FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Type::TaggedSymbol ) ONE_TIME_PAYMENT = - T.let(:one_time_payment, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Type::TaggedSymbol) + T.let( + :one_time_payment, + FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Type::TaggedSymbol + ) sig do - override - .returns(T::Array[FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Type::TaggedSymbol]) + override.returns( + T::Array[ + FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Type::TaggedSymbol + ] + ) + end + def self.values end - def self.values; end end end end diff --git a/rbi/finch_api/models/sandbox/payment_create_response.rbi b/rbi/finch_api/models/sandbox/payment_create_response.rbi index b2258095..0026d74c 100644 --- a/rbi/finch_api/models/sandbox/payment_create_response.rbi +++ b/rbi/finch_api/models/sandbox/payment_create_response.rbi @@ -4,6 +4,9 @@ module FinchAPI module Models module Sandbox class PaymentCreateResponse < FinchAPI::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + # The date of the payment. sig { returns(String) } attr_accessor :pay_date @@ -12,15 +15,20 @@ module FinchAPI sig { returns(String) } attr_accessor :payment_id - sig { params(pay_date: String, payment_id: String).returns(T.attached_class) } + sig do + params(pay_date: String, payment_id: String).returns(T.attached_class) + end def self.new( # The date of the payment. pay_date:, # The ID of the payment. payment_id: - ); end - sig { override.returns({pay_date: String, payment_id: String}) } - def to_hash; end + ) + end + + sig { override.returns({ pay_date: String, payment_id: String }) } + def to_hash + end end end end diff --git a/rbi/finch_api/models/webhook_event.rbi b/rbi/finch_api/models/webhook_event.rbi index f2835def..d4a967c7 100644 --- a/rbi/finch_api/models/webhook_event.rbi +++ b/rbi/finch_api/models/webhook_event.rbi @@ -5,13 +5,23 @@ module FinchAPI module WebhookEvent extend FinchAPI::Internal::Type::Union - 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] + Variants = + T.type_alias do + T.any( + FinchAPI::AccountUpdateEvent, + FinchAPI::CompanyEvent, + FinchAPI::JobCompletionEvent, + FinchAPI::DirectoryEvent, + FinchAPI::EmploymentEvent, + FinchAPI::IndividualEvent, + FinchAPI::PaymentEvent, + FinchAPI::PayStatementEvent ) + end + + sig { override.returns(T::Array[FinchAPI::WebhookEvent::Variants]) } + def self.variants end - def self.variants; end end end end diff --git a/rbi/finch_api/request_options.rbi b/rbi/finch_api/request_options.rbi index 535d75f1..75da1f93 100644 --- a/rbi/finch_api/request_options.rbi +++ b/rbi/finch_api/request_options.rbi @@ -1,17 +1,18 @@ # typed: strong module FinchAPI - RequestOpts = T.type_alias { T.any(FinchAPI::RequestOptions, FinchAPI::Internal::AnyHash) } - # 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::Internal::Type::BaseModel + OrHash = T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) } + # @api private - sig { params(opts: T.any(T.self_type, T::Hash[Symbol, T.anything])).void } - def self.validate!(opts); end + sig { params(opts: FinchAPI::RequestOptions::OrHash).void } + def self.validate!(opts) + end # Idempotency key to send with request and all associated retries. Will only be # sent for write requests. @@ -20,7 +21,11 @@ module FinchAPI # 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))])) } + sig do + returns( + T.nilable(T::Hash[String, T.nilable(T.any(T::Array[String], String))]) + ) + end attr_accessor :extra_query # Extra headers to send with the request. These are `.merged`’d into any @@ -42,7 +47,10 @@ module FinchAPI attr_accessor :timeout # Returns a new instance of RequestOptions. - sig { params(values: FinchAPI::Internal::AnyHash).returns(T.attached_class) } - def self.new(values = {}); end + sig do + params(values: FinchAPI::Internal::AnyHash).returns(T.attached_class) + end + def self.new(values = {}) + end end end diff --git a/rbi/finch_api/resources/access_tokens.rbi b/rbi/finch_api/resources/access_tokens.rbi index 2c98bc9f..db1349d5 100644 --- a/rbi/finch_api/resources/access_tokens.rbi +++ b/rbi/finch_api/resources/access_tokens.rbi @@ -10,15 +10,22 @@ module FinchAPI client_id: String, client_secret: String, redirect_uri: String, - request_options: FinchAPI::RequestOpts - ) - .returns(FinchAPI::Models::CreateAccessTokenResponse) + request_options: FinchAPI::RequestOptions::OrHash + ).returns(FinchAPI::CreateAccessTokenResponse) + end + def create( + code:, + client_id: nil, + client_secret: nil, + redirect_uri: nil, + request_options: {} + ) end - def create(code:, client_id: nil, client_secret: nil, redirect_uri: nil, request_options: {}); end # @api private sig { params(client: FinchAPI::Client).returns(T.attached_class) } - def self.new(client:); end + def self.new(client:) + end end end end diff --git a/rbi/finch_api/resources/account.rbi b/rbi/finch_api/resources/account.rbi index 22b98cb5..789e753f 100644 --- a/rbi/finch_api/resources/account.rbi +++ b/rbi/finch_api/resources/account.rbi @@ -4,16 +4,27 @@ module FinchAPI module Resources class Account # Disconnect one or more `access_token`s from your application. - sig { params(request_options: FinchAPI::RequestOpts).returns(FinchAPI::Models::DisconnectResponse) } - def disconnect(request_options: {}); end + sig do + params(request_options: FinchAPI::RequestOptions::OrHash).returns( + FinchAPI::DisconnectResponse + ) + end + def disconnect(request_options: {}) + end # Read account information associated with an `access_token` - sig { params(request_options: FinchAPI::RequestOpts).returns(FinchAPI::Models::Introspection) } - def introspect(request_options: {}); end + sig do + params(request_options: FinchAPI::RequestOptions::OrHash).returns( + FinchAPI::Introspection + ) + end + def introspect(request_options: {}) + end # @api private sig { params(client: FinchAPI::Client).returns(T.attached_class) } - def self.new(client:); end + def self.new(client:) + end end end end diff --git a/rbi/finch_api/resources/connect.rbi b/rbi/finch_api/resources/connect.rbi index b647069c..63c93029 100644 --- a/rbi/finch_api/resources/connect.rbi +++ b/rbi/finch_api/resources/connect.rbi @@ -8,7 +8,8 @@ module FinchAPI # @api private sig { params(client: FinchAPI::Client).returns(T.attached_class) } - def self.new(client:); end + def self.new(client:) + end end end end diff --git a/rbi/finch_api/resources/connect/sessions.rbi b/rbi/finch_api/resources/connect/sessions.rbi index 2e633a67..274f0674 100644 --- a/rbi/finch_api/resources/connect/sessions.rbi +++ b/rbi/finch_api/resources/connect/sessions.rbi @@ -9,16 +9,20 @@ module FinchAPI params( customer_id: String, customer_name: String, - products: T::Array[FinchAPI::Models::Connect::SessionNewParams::Product::OrSymbol], + products: + T::Array[FinchAPI::Connect::SessionNewParams::Product::OrSymbol], customer_email: T.nilable(String), - integration: T.nilable(T.any(FinchAPI::Models::Connect::SessionNewParams::Integration, FinchAPI::Internal::AnyHash)), + integration: + T.nilable( + FinchAPI::Connect::SessionNewParams::Integration::OrHash + ), 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: FinchAPI::RequestOpts - ) - .returns(FinchAPI::Models::Connect::SessionNewResponse) + sandbox: + T.nilable(FinchAPI::Connect::SessionNewParams::Sandbox::OrSymbol), + request_options: FinchAPI::RequestOptions::OrHash + ).returns(FinchAPI::Models::Connect::SessionNewResponse) end def new( customer_id:, @@ -33,17 +37,23 @@ module FinchAPI redirect_uri: nil, sandbox: nil, request_options: {} - ); end + ) + end + # Create a new Connect session for reauthenticating an existing connection sig do params( connection_id: String, minutes_to_expire: T.nilable(Integer), - products: T.nilable(T::Array[FinchAPI::Models::Connect::SessionReauthenticateParams::Product::OrSymbol]), + products: + T.nilable( + T::Array[ + FinchAPI::Connect::SessionReauthenticateParams::Product::OrSymbol + ] + ), redirect_uri: T.nilable(String), - request_options: FinchAPI::RequestOpts - ) - .returns(FinchAPI::Models::Connect::SessionReauthenticateResponse) + request_options: FinchAPI::RequestOptions::OrHash + ).returns(FinchAPI::Models::Connect::SessionReauthenticateResponse) end def reauthenticate( # The ID of the existing connection to reauthenticate @@ -56,10 +66,13 @@ module FinchAPI # The URI to redirect to after the Connect flow is completed redirect_uri: nil, request_options: {} - ); end + ) + end + # @api private sig { params(client: FinchAPI::Client).returns(T.attached_class) } - def self.new(client:); end + def self.new(client:) + end end end end diff --git a/rbi/finch_api/resources/hris.rbi b/rbi/finch_api/resources/hris.rbi index 8a76d043..460c720e 100644 --- a/rbi/finch_api/resources/hris.rbi +++ b/rbi/finch_api/resources/hris.rbi @@ -29,7 +29,8 @@ module FinchAPI # @api private sig { params(client: FinchAPI::Client).returns(T.attached_class) } - def self.new(client:); end + def self.new(client:) + end end end end diff --git a/rbi/finch_api/resources/hris/benefits.rbi b/rbi/finch_api/resources/hris/benefits.rbi index f580b301..e17e54a4 100644 --- a/rbi/finch_api/resources/hris/benefits.rbi +++ b/rbi/finch_api/resources/hris/benefits.rbi @@ -11,15 +11,15 @@ module FinchAPI # `/providers` endpoint to view available types for each provider. sig do params( - company_contribution: T.nilable( - T.any(FinchAPI::Models::HRIS::BenefitCreateParams::CompanyContribution, FinchAPI::Internal::AnyHash) - ), + company_contribution: + T.nilable( + FinchAPI::HRIS::BenefitCreateParams::CompanyContribution::OrHash + ), description: String, - frequency: T.nilable(FinchAPI::Models::HRIS::BenefitFrequency::OrSymbol), - type: T.nilable(FinchAPI::Models::HRIS::BenefitType::OrSymbol), - request_options: FinchAPI::RequestOpts - ) - .returns(FinchAPI::Models::HRIS::CreateCompanyBenefitsResponse) + frequency: T.nilable(FinchAPI::HRIS::BenefitFrequency::OrSymbol), + type: T.nilable(FinchAPI::HRIS::BenefitType::OrSymbol), + request_options: FinchAPI::RequestOptions::OrHash + ).returns(FinchAPI::HRIS::CreateCompanyBenefitsResponse) end def create( # The company match for this benefit. @@ -33,42 +33,59 @@ module FinchAPI # Type of benefit. type: nil, request_options: {} - ); end + ) + end + # Lists deductions and contributions information for a given item sig do - params(benefit_id: String, request_options: FinchAPI::RequestOpts) - .returns(FinchAPI::Models::HRIS::CompanyBenefit) + params( + benefit_id: String, + request_options: FinchAPI::RequestOptions::OrHash + ).returns(FinchAPI::HRIS::CompanyBenefit) + end + def retrieve(benefit_id, request_options: {}) end - def retrieve(benefit_id, request_options: {}); end # Updates an existing company-wide deduction or contribution sig do - params(benefit_id: String, description: String, request_options: FinchAPI::RequestOpts) - .returns(FinchAPI::Models::HRIS::UpdateCompanyBenefitResponse) + params( + benefit_id: String, + description: String, + request_options: FinchAPI::RequestOptions::OrHash + ).returns(FinchAPI::HRIS::UpdateCompanyBenefitResponse) end def update( benefit_id, # Updated name or description. description: nil, request_options: {} - ); end + ) + end + # List all company-wide deductions and contributions. sig do - params(request_options: FinchAPI::RequestOpts) - .returns(FinchAPI::Internal::SinglePage[FinchAPI::Models::HRIS::CompanyBenefit]) + params(request_options: FinchAPI::RequestOptions::OrHash).returns( + FinchAPI::Internal::SinglePage[FinchAPI::HRIS::CompanyBenefit] + ) + end + def list(request_options: {}) end - def list(request_options: {}); end # Get deductions metadata sig do - params(request_options: FinchAPI::RequestOpts) - .returns(FinchAPI::Internal::SinglePage[FinchAPI::Models::HRIS::BenefitListSupportedBenefitsResponse]) + params(request_options: FinchAPI::RequestOptions::OrHash).returns( + FinchAPI::Internal::SinglePage[ + FinchAPI::Models::HRIS::BenefitListSupportedBenefitsResponse + ] + ) + end + def list_supported_benefits(request_options: {}) end - def list_supported_benefits(request_options: {}); end # @api private sig { params(client: FinchAPI::Client).returns(T.attached_class) } - def self.new(client:); end + def self.new(client:) + end end end end diff --git a/rbi/finch_api/resources/hris/benefits/individuals.rbi b/rbi/finch_api/resources/hris/benefits/individuals.rbi index 151e0eb7..57de0568 100644 --- a/rbi/finch_api/resources/hris/benefits/individuals.rbi +++ b/rbi/finch_api/resources/hris/benefits/individuals.rbi @@ -12,33 +12,46 @@ module FinchAPI sig do params( benefit_id: String, - individuals: T::Array[ - T.any( - FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual, - FinchAPI::Internal::AnyHash - ) - ], - request_options: FinchAPI::RequestOpts + individuals: + T::Array[ + FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::OrHash + ], + request_options: FinchAPI::RequestOptions::OrHash + ).returns( + FinchAPI::HRIS::Benefits::EnrolledIndividualBenefitResponse ) - .returns(FinchAPI::Models::HRIS::Benefits::EnrolledIndividualBenefitResponse) end def enroll_many( benefit_id, # Array of the individual_id to enroll and a configuration object. individuals: nil, request_options: {} - ); end + ) + end + # Lists individuals currently enrolled in a given deduction. sig do - params(benefit_id: String, request_options: FinchAPI::RequestOpts) - .returns(FinchAPI::Models::HRIS::Benefits::IndividualEnrolledIDsResponse) + params( + benefit_id: String, + request_options: FinchAPI::RequestOptions::OrHash + ).returns( + FinchAPI::Models::HRIS::Benefits::IndividualEnrolledIDsResponse + ) + end + def enrolled_ids(benefit_id, request_options: {}) end - def enrolled_ids(benefit_id, request_options: {}); end # Get enrollment information for the given individuals. sig do - params(benefit_id: String, individual_ids: String, request_options: FinchAPI::RequestOpts) - .returns(FinchAPI::Internal::SinglePage[FinchAPI::Models::HRIS::Benefits::IndividualBenefit]) + params( + benefit_id: String, + individual_ids: String, + request_options: FinchAPI::RequestOptions::OrHash + ).returns( + FinchAPI::Internal::SinglePage[ + FinchAPI::HRIS::Benefits::IndividualBenefit + ] + ) end def retrieve_many_benefits( benefit_id, @@ -46,25 +59,31 @@ module FinchAPI # defaults to all individuals individual_ids: nil, request_options: {} - ); end + ) + end + # Unenroll individuals from a deduction or contribution sig do params( benefit_id: String, individual_ids: T::Array[String], - request_options: FinchAPI::RequestOpts + request_options: FinchAPI::RequestOptions::OrHash + ).returns( + FinchAPI::HRIS::Benefits::UnenrolledIndividualBenefitResponse ) - .returns(FinchAPI::Models::HRIS::Benefits::UnenrolledIndividualBenefitResponse) end def unenroll_many( benefit_id, # Array of individual_ids to unenroll. individual_ids: nil, request_options: {} - ); end + ) + end + # @api private sig { params(client: FinchAPI::Client).returns(T.attached_class) } - def self.new(client:); end + def self.new(client:) + end end end end diff --git a/rbi/finch_api/resources/hris/company.rbi b/rbi/finch_api/resources/hris/company.rbi index d4645081..e6c65b13 100644 --- a/rbi/finch_api/resources/hris/company.rbi +++ b/rbi/finch_api/resources/hris/company.rbi @@ -8,12 +8,18 @@ module FinchAPI attr_reader :pay_statement_item # Read basic company data - sig { params(request_options: FinchAPI::RequestOpts).returns(FinchAPI::Models::HRIS::HRISCompany) } - def retrieve(request_options: {}); end + sig do + params(request_options: FinchAPI::RequestOptions::OrHash).returns( + FinchAPI::HRIS::HRISCompany + ) + end + def retrieve(request_options: {}) + end # @api private sig { params(client: FinchAPI::Client).returns(T.attached_class) } - def self.new(client:); end + def self.new(client:) + end end end end diff --git a/rbi/finch_api/resources/hris/company/pay_statement_item.rbi b/rbi/finch_api/resources/hris/company/pay_statement_item.rbi index e8265f07..5ef7fece 100644 --- a/rbi/finch_api/resources/hris/company/pay_statement_item.rbi +++ b/rbi/finch_api/resources/hris/company/pay_statement_item.rbi @@ -5,7 +5,9 @@ module FinchAPI class HRIS class Company class PayStatementItem - sig { returns(FinchAPI::Resources::HRIS::Company::PayStatementItem::Rules) } + sig do + returns(FinchAPI::Resources::HRIS::Company::PayStatementItem::Rules) + end attr_reader :rules # **Beta:** this endpoint currently serves employers onboarded after March 4th and @@ -13,14 +15,20 @@ module FinchAPI # items for the access token's connection account. sig do params( - categories: T::Array[FinchAPI::Models::HRIS::Company::PayStatementItemListParams::Category::OrSymbol], + categories: + T::Array[ + FinchAPI::HRIS::Company::PayStatementItemListParams::Category::OrSymbol + ], end_date: Date, name: String, start_date: Date, type: String, - request_options: FinchAPI::RequestOpts + request_options: FinchAPI::RequestOptions::OrHash + ).returns( + FinchAPI::Internal::ResponsesPage[ + FinchAPI::Models::HRIS::Company::PayStatementItemListResponse + ] ) - .returns(FinchAPI::Internal::ResponsesPage[FinchAPI::Models::HRIS::Company::PayStatementItemListResponse]) end def list( # Comma-delimited list of pay statement item categories to filter on. If empty, @@ -37,10 +45,13 @@ module FinchAPI # String search by pay statement item type. type: nil, request_options: {} - ); end + ) + end + # @api private sig { params(client: FinchAPI::Client).returns(T.attached_class) } - def self.new(client:); end + def self.new(client:) + end end end end diff --git a/rbi/finch_api/resources/hris/company/pay_statement_item/rules.rbi b/rbi/finch_api/resources/hris/company/pay_statement_item/rules.rbi index 73c99e6f..f6b35e79 100644 --- a/rbi/finch_api/resources/hris/company/pay_statement_item/rules.rbi +++ b/rbi/finch_api/resources/hris/company/pay_statement_item/rules.rbi @@ -14,22 +14,20 @@ module FinchAPI # information is available. sig do params( - attributes: T.any( - FinchAPI::Models::HRIS::Company::PayStatementItem::RuleCreateParams::Attributes, - FinchAPI::Internal::AnyHash - ), - conditions: T::Array[ - T.any( - FinchAPI::Models::HRIS::Company::PayStatementItem::RuleCreateParams::Condition, - FinchAPI::Internal::AnyHash - ) - ], + attributes: + FinchAPI::HRIS::Company::PayStatementItem::RuleCreateParams::Attributes::OrHash, + conditions: + T::Array[ + FinchAPI::HRIS::Company::PayStatementItem::RuleCreateParams::Condition::OrHash + ], effective_end_date: T.nilable(String), effective_start_date: T.nilable(String), - entity_type: FinchAPI::Models::HRIS::Company::PayStatementItem::RuleCreateParams::EntityType::OrSymbol, - request_options: FinchAPI::RequestOpts + entity_type: + FinchAPI::HRIS::Company::PayStatementItem::RuleCreateParams::EntityType::OrSymbol, + request_options: FinchAPI::RequestOptions::OrHash + ).returns( + FinchAPI::Models::HRIS::Company::PayStatementItem::RuleCreateResponse ) - .returns(FinchAPI::Models::HRIS::Company::PayStatementItem::RuleCreateResponse) end def create( # Specifies the fields to be applied when the condition is met. @@ -42,36 +40,52 @@ module FinchAPI # The entity type to which the rule is applied. entity_type: nil, request_options: {} - ); end + ) + end + # **Beta:** this endpoint currently serves employers onboarded after March 4th and # historical support will be added soon Update a rule for a pay statement item. sig do - params(rule_id: String, optional_property: T.anything, request_options: FinchAPI::RequestOpts) - .returns(FinchAPI::Models::HRIS::Company::PayStatementItem::RuleUpdateResponse) + params( + rule_id: String, + optional_property: T.anything, + request_options: FinchAPI::RequestOptions::OrHash + ).returns( + FinchAPI::Models::HRIS::Company::PayStatementItem::RuleUpdateResponse + ) + end + def update(rule_id, optional_property: nil, request_options: {}) end - def update(rule_id, optional_property: nil, request_options: {}); end # **Beta:** this endpoint currently serves employers onboarded after March 4th and # historical support will be added soon List all rules of a connection account. sig do - params(request_options: FinchAPI::RequestOpts) - .returns( - FinchAPI::Internal::ResponsesPage[FinchAPI::Models::HRIS::Company::PayStatementItem::RuleListResponse] - ) + params(request_options: FinchAPI::RequestOptions::OrHash).returns( + FinchAPI::Internal::ResponsesPage[ + FinchAPI::Models::HRIS::Company::PayStatementItem::RuleListResponse + ] + ) + end + def list(request_options: {}) end - def list(request_options: {}); end # **Beta:** this endpoint currently serves employers onboarded after March 4th and # historical support will be added soon Delete a rule for a pay statement item. sig do - params(rule_id: String, request_options: FinchAPI::RequestOpts) - .returns(FinchAPI::Models::HRIS::Company::PayStatementItem::RuleDeleteResponse) + params( + rule_id: String, + request_options: FinchAPI::RequestOptions::OrHash + ).returns( + FinchAPI::Models::HRIS::Company::PayStatementItem::RuleDeleteResponse + ) + end + def delete(rule_id, request_options: {}) end - def delete(rule_id, request_options: {}); end # @api private sig { params(client: FinchAPI::Client).returns(T.attached_class) } - def self.new(client:); end + def self.new(client:) + end end end end diff --git a/rbi/finch_api/resources/hris/directory.rbi b/rbi/finch_api/resources/hris/directory.rbi index f0bb912c..f795b9b5 100644 --- a/rbi/finch_api/resources/hris/directory.rbi +++ b/rbi/finch_api/resources/hris/directory.rbi @@ -6,8 +6,15 @@ module FinchAPI class Directory # Read company directory and organization structure sig do - params(limit: Integer, offset: Integer, request_options: FinchAPI::RequestOpts) - .returns(FinchAPI::Internal::IndividualsPage[FinchAPI::Models::HRIS::IndividualInDirectory]) + params( + limit: Integer, + offset: Integer, + request_options: FinchAPI::RequestOptions::OrHash + ).returns( + FinchAPI::Internal::IndividualsPage[ + FinchAPI::HRIS::IndividualInDirectory + ] + ) end def list( # Number of employees to return (defaults to all) @@ -15,10 +22,13 @@ module FinchAPI # Index to start from (defaults to 0) offset: nil, request_options: {} - ); end + ) + end + # @api private sig { params(client: FinchAPI::Client).returns(T.attached_class) } - def self.new(client:); end + def self.new(client:) + end end end end diff --git a/rbi/finch_api/resources/hris/documents.rbi b/rbi/finch_api/resources/hris/documents.rbi index 8200b6a9..5d9aca46 100644 --- a/rbi/finch_api/resources/hris/documents.rbi +++ b/rbi/finch_api/resources/hris/documents.rbi @@ -11,10 +11,9 @@ module FinchAPI individual_ids: T::Array[String], limit: Integer, offset: Integer, - types: T::Array[FinchAPI::Models::HRIS::DocumentListParams::Type::OrSymbol], - request_options: FinchAPI::RequestOpts - ) - .returns(FinchAPI::Models::HRIS::DocumentListResponse) + types: T::Array[FinchAPI::HRIS::DocumentListParams::Type::OrSymbol], + request_options: FinchAPI::RequestOptions::OrHash + ).returns(FinchAPI::Models::HRIS::DocumentListResponse) end def list( # Comma-delimited list of stable Finch uuids for each individual. If empty, @@ -28,21 +27,28 @@ module FinchAPI # types types: nil, request_options: {} - ); end + ) + 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, request_options: FinchAPI::RequestOpts) - .returns(T.any(FinchAPI::Models::HRIS::W42020, FinchAPI::Models::HRIS::W42005)) + params( + document_id: String, + request_options: FinchAPI::RequestOptions::OrHash + ).returns(T.any(FinchAPI::HRIS::W42020, FinchAPI::HRIS::W42005)) end def retreive( # The unique identifier of the document. document_id, request_options: {} - ); end + ) + end + # @api private sig { params(client: FinchAPI::Client).returns(T.attached_class) } - def self.new(client:); end + def self.new(client:) + end end end end diff --git a/rbi/finch_api/resources/hris/employments.rbi b/rbi/finch_api/resources/hris/employments.rbi index bcb56451..b585efa8 100644 --- a/rbi/finch_api/resources/hris/employments.rbi +++ b/rbi/finch_api/resources/hris/employments.rbi @@ -7,19 +7,28 @@ module FinchAPI # Read individual employment and income data sig do params( - requests: T::Array[T.any(FinchAPI::Models::HRIS::EmploymentRetrieveManyParams::Request, FinchAPI::Internal::AnyHash)], - request_options: FinchAPI::RequestOpts + requests: + T::Array[ + FinchAPI::HRIS::EmploymentRetrieveManyParams::Request::OrHash + ], + request_options: FinchAPI::RequestOptions::OrHash + ).returns( + FinchAPI::Internal::ResponsesPage[ + FinchAPI::HRIS::EmploymentDataResponse + ] ) - .returns(FinchAPI::Internal::ResponsesPage[FinchAPI::Models::HRIS::EmploymentDataResponse]) end def retrieve_many( # The array of batch requests. requests:, request_options: {} - ); end + ) + end + # @api private sig { params(client: FinchAPI::Client).returns(T.attached_class) } - def self.new(client:); end + def self.new(client:) + end end end end diff --git a/rbi/finch_api/resources/hris/individuals.rbi b/rbi/finch_api/resources/hris/individuals.rbi index 9a2e2ddb..54724b67 100644 --- a/rbi/finch_api/resources/hris/individuals.rbi +++ b/rbi/finch_api/resources/hris/individuals.rbi @@ -7,19 +7,28 @@ module FinchAPI # Read individual data, excluding income and employment data sig do params( - options: T.nilable( - T.any(FinchAPI::Models::HRIS::IndividualRetrieveManyParams::Options, FinchAPI::Internal::AnyHash) - ), - requests: T::Array[T.any(FinchAPI::Models::HRIS::IndividualRetrieveManyParams::Request, FinchAPI::Internal::AnyHash)], - request_options: FinchAPI::RequestOpts + options: + T.nilable( + FinchAPI::HRIS::IndividualRetrieveManyParams::Options::OrHash + ), + requests: + T::Array[ + FinchAPI::HRIS::IndividualRetrieveManyParams::Request::OrHash + ], + request_options: FinchAPI::RequestOptions::OrHash + ).returns( + FinchAPI::Internal::ResponsesPage[ + FinchAPI::HRIS::IndividualResponse + ] ) - .returns(FinchAPI::Internal::ResponsesPage[FinchAPI::Models::HRIS::IndividualResponse]) end - def retrieve_many(options: nil, requests: nil, request_options: {}); end + def retrieve_many(options: nil, requests: nil, request_options: {}) + end # @api private sig { params(client: FinchAPI::Client).returns(T.attached_class) } - def self.new(client:); end + def self.new(client:) + end end end end diff --git a/rbi/finch_api/resources/hris/pay_statements.rbi b/rbi/finch_api/resources/hris/pay_statements.rbi index bc3493bd..69ad5dec 100644 --- a/rbi/finch_api/resources/hris/pay_statements.rbi +++ b/rbi/finch_api/resources/hris/pay_statements.rbi @@ -10,19 +10,28 @@ module FinchAPI # supports Benefits. sig do params( - requests: T::Array[T.any(FinchAPI::Models::HRIS::PayStatementRetrieveManyParams::Request, FinchAPI::Internal::AnyHash)], - request_options: FinchAPI::RequestOpts + requests: + T::Array[ + FinchAPI::HRIS::PayStatementRetrieveManyParams::Request::OrHash + ], + request_options: FinchAPI::RequestOptions::OrHash + ).returns( + FinchAPI::Internal::ResponsesPage[ + FinchAPI::HRIS::PayStatementResponse + ] ) - .returns(FinchAPI::Internal::ResponsesPage[FinchAPI::Models::HRIS::PayStatementResponse]) end def retrieve_many( # The array of batch requests. requests:, request_options: {} - ); end + ) + end + # @api private sig { params(client: FinchAPI::Client).returns(T.attached_class) } - def self.new(client:); end + def self.new(client:) + end end end end diff --git a/rbi/finch_api/resources/hris/payments.rbi b/rbi/finch_api/resources/hris/payments.rbi index a25c643b..07f378dc 100644 --- a/rbi/finch_api/resources/hris/payments.rbi +++ b/rbi/finch_api/resources/hris/payments.rbi @@ -6,8 +6,11 @@ module FinchAPI class Payments # Read payroll and contractor related payments by the company. sig do - params(end_date: Date, start_date: Date, request_options: FinchAPI::RequestOpts) - .returns(FinchAPI::Internal::SinglePage[FinchAPI::Models::HRIS::Payment]) + params( + end_date: Date, + start_date: Date, + request_options: FinchAPI::RequestOptions::OrHash + ).returns(FinchAPI::Internal::SinglePage[FinchAPI::HRIS::Payment]) end def list( # The end date to retrieve payments by a company (inclusive) in `YYYY-MM-DD` @@ -17,10 +20,13 @@ module FinchAPI # format. start_date:, request_options: {} - ); end + ) + end + # @api private sig { params(client: FinchAPI::Client).returns(T.attached_class) } - def self.new(client:); end + def self.new(client:) + end end end end diff --git a/rbi/finch_api/resources/jobs.rbi b/rbi/finch_api/resources/jobs.rbi index bc73497f..58bbffff 100644 --- a/rbi/finch_api/resources/jobs.rbi +++ b/rbi/finch_api/resources/jobs.rbi @@ -11,7 +11,8 @@ module FinchAPI # @api private sig { params(client: FinchAPI::Client).returns(T.attached_class) } - def self.new(client:); end + def self.new(client:) + end end end end diff --git a/rbi/finch_api/resources/jobs/automated.rbi b/rbi/finch_api/resources/jobs/automated.rbi index e17be991..8a14e34f 100644 --- a/rbi/finch_api/resources/jobs/automated.rbi +++ b/rbi/finch_api/resources/jobs/automated.rbi @@ -20,31 +20,38 @@ module FinchAPI # access to this endpoint, please contact your Finch account manager. sig do params( - type: FinchAPI::Models::Jobs::AutomatedCreateParams::Type::OrSymbol, - params: T.any(FinchAPI::Models::Jobs::AutomatedCreateParams::Params, FinchAPI::Internal::AnyHash), - request_options: FinchAPI::RequestOpts - ) - .returns(FinchAPI::Models::Jobs::AutomatedCreateResponse) + type: FinchAPI::Jobs::AutomatedCreateParams::Type::OrSymbol, + params: FinchAPI::Jobs::AutomatedCreateParams::Params::OrHash, + request_options: FinchAPI::RequestOptions::OrHash + ).returns(FinchAPI::Models::Jobs::AutomatedCreateResponse) end def create( # The type of job to start. type:, params:, request_options: {} - ); end + ) + end + # Get an automated job by `job_id`. sig do - params(job_id: String, request_options: FinchAPI::RequestOpts) - .returns(FinchAPI::Models::Jobs::AutomatedAsyncJob) + params( + job_id: String, + request_options: FinchAPI::RequestOptions::OrHash + ).returns(FinchAPI::Jobs::AutomatedAsyncJob) + end + def retrieve(job_id, request_options: {}) end - 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, offset: Integer, request_options: FinchAPI::RequestOpts) - .returns(FinchAPI::Models::Jobs::AutomatedListResponse) + params( + limit: Integer, + offset: Integer, + request_options: FinchAPI::RequestOptions::OrHash + ).returns(FinchAPI::Models::Jobs::AutomatedListResponse) end def list( # Number of items to return @@ -52,10 +59,13 @@ module FinchAPI # Index to start from (defaults to 0) offset: nil, request_options: {} - ); end + ) + end + # @api private sig { params(client: FinchAPI::Client).returns(T.attached_class) } - def self.new(client:); end + def self.new(client:) + end end end end diff --git a/rbi/finch_api/resources/jobs/manual.rbi b/rbi/finch_api/resources/jobs/manual.rbi index b9a14846..ca91bfdb 100644 --- a/rbi/finch_api/resources/jobs/manual.rbi +++ b/rbi/finch_api/resources/jobs/manual.rbi @@ -7,14 +7,18 @@ module FinchAPI # 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, request_options: FinchAPI::RequestOpts) - .returns(FinchAPI::Models::Jobs::ManualAsyncJob) + params( + job_id: String, + request_options: FinchAPI::RequestOptions::OrHash + ).returns(FinchAPI::Jobs::ManualAsyncJob) + end + def retrieve(job_id, request_options: {}) end - def retrieve(job_id, request_options: {}); end # @api private sig { params(client: FinchAPI::Client).returns(T.attached_class) } - def self.new(client:); end + def self.new(client:) + end end end end diff --git a/rbi/finch_api/resources/payroll.rbi b/rbi/finch_api/resources/payroll.rbi index 692e69d5..922677a1 100644 --- a/rbi/finch_api/resources/payroll.rbi +++ b/rbi/finch_api/resources/payroll.rbi @@ -8,7 +8,8 @@ module FinchAPI # @api private sig { params(client: FinchAPI::Client).returns(T.attached_class) } - def self.new(client:); end + def self.new(client:) + end end end end diff --git a/rbi/finch_api/resources/payroll/pay_groups.rbi b/rbi/finch_api/resources/payroll/pay_groups.rbi index ee91bcba..c06cf3b8 100644 --- a/rbi/finch_api/resources/payroll/pay_groups.rbi +++ b/rbi/finch_api/resources/payroll/pay_groups.rbi @@ -6,25 +6,33 @@ module FinchAPI class PayGroups # Read information from a single pay group sig do - params(pay_group_id: String, request_options: FinchAPI::RequestOpts) - .returns(FinchAPI::Models::Payroll::PayGroupRetrieveResponse) + params( + pay_group_id: String, + request_options: FinchAPI::RequestOptions::OrHash + ).returns(FinchAPI::Models::Payroll::PayGroupRetrieveResponse) + end + def retrieve(pay_group_id, request_options: {}) end - def retrieve(pay_group_id, request_options: {}); end # Read company pay groups and frequencies sig do params( individual_id: String, pay_frequencies: T::Array[String], - request_options: FinchAPI::RequestOpts + request_options: FinchAPI::RequestOptions::OrHash + ).returns( + FinchAPI::Internal::SinglePage[ + FinchAPI::Models::Payroll::PayGroupListResponse + ] ) - .returns(FinchAPI::Internal::SinglePage[FinchAPI::Models::Payroll::PayGroupListResponse]) end - def list(individual_id: nil, pay_frequencies: nil, request_options: {}); end + def list(individual_id: nil, pay_frequencies: nil, request_options: {}) + end # @api private sig { params(client: FinchAPI::Client).returns(T.attached_class) } - def self.new(client:); end + def self.new(client:) + end end end end diff --git a/rbi/finch_api/resources/providers.rbi b/rbi/finch_api/resources/providers.rbi index f52f0f02..dcca71ad 100644 --- a/rbi/finch_api/resources/providers.rbi +++ b/rbi/finch_api/resources/providers.rbi @@ -5,14 +5,17 @@ module FinchAPI class Providers # Return details on all available payroll and HR systems. sig do - params(request_options: FinchAPI::RequestOpts) - .returns(FinchAPI::Internal::SinglePage[FinchAPI::Models::Provider]) + params(request_options: FinchAPI::RequestOptions::OrHash).returns( + FinchAPI::Internal::SinglePage[FinchAPI::Provider] + ) + end + def list(request_options: {}) end - def list(request_options: {}); end # @api private sig { params(client: FinchAPI::Client).returns(T.attached_class) } - def self.new(client:); end + def self.new(client:) + end end end end diff --git a/rbi/finch_api/resources/request_forwarding.rbi b/rbi/finch_api/resources/request_forwarding.rbi index 92d3c5cf..d1f44e45 100644 --- a/rbi/finch_api/resources/request_forwarding.rbi +++ b/rbi/finch_api/resources/request_forwarding.rbi @@ -14,9 +14,8 @@ module FinchAPI data: T.nilable(String), headers: T.nilable(T.anything), params: T.nilable(T.anything), - request_options: FinchAPI::RequestOpts - ) - .returns(FinchAPI::Models::RequestForwardingForwardResponse) + request_options: FinchAPI::RequestOptions::OrHash + ).returns(FinchAPI::Models::RequestForwardingForwardResponse) end def forward( # The HTTP method for the forwarded request. Valid values include: `GET` , `POST` @@ -37,10 +36,13 @@ module FinchAPI # a valid JSON object rather than a query string. params: nil, request_options: {} - ); end + ) + end + # @api private sig { params(client: FinchAPI::Client).returns(T.attached_class) } - def self.new(client:); end + def self.new(client:) + end end end end diff --git a/rbi/finch_api/resources/sandbox.rbi b/rbi/finch_api/resources/sandbox.rbi index 84634c40..4d3407f7 100644 --- a/rbi/finch_api/resources/sandbox.rbi +++ b/rbi/finch_api/resources/sandbox.rbi @@ -26,7 +26,8 @@ module FinchAPI # @api private sig { params(client: FinchAPI::Client).returns(T.attached_class) } - def self.new(client:); end + def self.new(client:) + end end end end diff --git a/rbi/finch_api/resources/sandbox/company.rbi b/rbi/finch_api/resources/sandbox/company.rbi index 7c53b8b0..e5a03b90 100644 --- a/rbi/finch_api/resources/sandbox/company.rbi +++ b/rbi/finch_api/resources/sandbox/company.rbi @@ -7,21 +7,30 @@ module FinchAPI # Update a sandbox company's data sig do params( - accounts: T.nilable( - T::Array[T.any(FinchAPI::Models::Sandbox::CompanyUpdateParams::Account, FinchAPI::Internal::AnyHash)] - ), - departments: T.nilable( - T::Array[T.nilable(T.any(FinchAPI::Models::Sandbox::CompanyUpdateParams::Department, FinchAPI::Internal::AnyHash))] - ), + accounts: + T.nilable( + T::Array[ + FinchAPI::Sandbox::CompanyUpdateParams::Account::OrHash + ] + ), + departments: + T.nilable( + T::Array[ + T.nilable( + FinchAPI::Sandbox::CompanyUpdateParams::Department::OrHash + ) + ] + ), ein: T.nilable(String), - entity: T.nilable(T.any(FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity, FinchAPI::Internal::AnyHash)), + entity: + T.nilable(FinchAPI::Sandbox::CompanyUpdateParams::Entity::OrHash), legal_name: T.nilable(String), - locations: T.nilable(T::Array[T.nilable(T.any(FinchAPI::Models::Location, FinchAPI::Internal::AnyHash))]), + locations: + T.nilable(T::Array[T.nilable(FinchAPI::Location::OrHash)]), primary_email: T.nilable(String), primary_phone_number: T.nilable(String), - request_options: FinchAPI::RequestOpts - ) - .returns(FinchAPI::Models::Sandbox::CompanyUpdateResponse) + request_options: FinchAPI::RequestOptions::OrHash + ).returns(FinchAPI::Models::Sandbox::CompanyUpdateResponse) end def update( # An array of bank account objects associated with the payroll/HRIS system. @@ -41,10 +50,13 @@ module FinchAPI # extension where applicable, e.g. `+NNNNNNNNNNN xExtension` primary_phone_number:, request_options: {} - ); end + ) + end + # @api private sig { params(client: FinchAPI::Client).returns(T.attached_class) } - def self.new(client:); end + def self.new(client:) + end end end end diff --git a/rbi/finch_api/resources/sandbox/connections.rbi b/rbi/finch_api/resources/sandbox/connections.rbi index 50e79c72..75d19987 100644 --- a/rbi/finch_api/resources/sandbox/connections.rbi +++ b/rbi/finch_api/resources/sandbox/connections.rbi @@ -11,12 +11,12 @@ module FinchAPI sig do params( provider_id: String, - authentication_type: FinchAPI::Models::Sandbox::ConnectionCreateParams::AuthenticationType::OrSymbol, + authentication_type: + FinchAPI::Sandbox::ConnectionCreateParams::AuthenticationType::OrSymbol, employee_size: Integer, products: T::Array[String], - request_options: FinchAPI::RequestOpts - ) - .returns(FinchAPI::Models::Sandbox::ConnectionCreateResponse) + request_options: FinchAPI::RequestOptions::OrHash + ).returns(FinchAPI::Models::Sandbox::ConnectionCreateResponse) end def create( # The provider associated with the connection @@ -28,10 +28,13 @@ module FinchAPI employee_size: nil, products: nil, request_options: {} - ); end + ) + end + # @api private sig { params(client: FinchAPI::Client).returns(T.attached_class) } - def self.new(client:); end + def self.new(client:) + end end end end diff --git a/rbi/finch_api/resources/sandbox/connections/accounts.rbi b/rbi/finch_api/resources/sandbox/connections/accounts.rbi index 373baf4b..83dd4fb2 100644 --- a/rbi/finch_api/resources/sandbox/connections/accounts.rbi +++ b/rbi/finch_api/resources/sandbox/connections/accounts.rbi @@ -10,11 +10,13 @@ module FinchAPI params( company_id: String, provider_id: String, - authentication_type: FinchAPI::Models::Sandbox::Connections::AccountCreateParams::AuthenticationType::OrSymbol, + authentication_type: + FinchAPI::Sandbox::Connections::AccountCreateParams::AuthenticationType::OrSymbol, products: T::Array[String], - request_options: FinchAPI::RequestOpts + request_options: FinchAPI::RequestOptions::OrHash + ).returns( + FinchAPI::Models::Sandbox::Connections::AccountCreateResponse ) - .returns(FinchAPI::Models::Sandbox::Connections::AccountCreateResponse) end def create( company_id:, @@ -25,21 +27,26 @@ module FinchAPI # `employment`, `individual`) products: nil, request_options: {} - ); end + ) + end + # Update an existing sandbox account. Change the connection status to understand # how the Finch API responds. sig do params( - connection_status: FinchAPI::Models::ConnectionStatusType::OrSymbol, - request_options: FinchAPI::RequestOpts + connection_status: FinchAPI::ConnectionStatusType::OrSymbol, + request_options: FinchAPI::RequestOptions::OrHash + ).returns( + FinchAPI::Models::Sandbox::Connections::AccountUpdateResponse ) - .returns(FinchAPI::Models::Sandbox::Connections::AccountUpdateResponse) end - def update(connection_status: nil, request_options: {}); end + def update(connection_status: nil, request_options: {}) + end # @api private sig { params(client: FinchAPI::Client).returns(T.attached_class) } - def self.new(client:); end + def self.new(client:) + end end end end diff --git a/rbi/finch_api/resources/sandbox/directory.rbi b/rbi/finch_api/resources/sandbox/directory.rbi index f01f2b8c..eecbe335 100644 --- a/rbi/finch_api/resources/sandbox/directory.rbi +++ b/rbi/finch_api/resources/sandbox/directory.rbi @@ -7,20 +7,23 @@ module FinchAPI # Add new individuals to a sandbox company sig do params( - body: T::Array[T.any(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body, FinchAPI::Internal::AnyHash)], - request_options: FinchAPI::RequestOpts - ) - .returns(T::Array[T.anything]) + body: + T::Array[FinchAPI::Sandbox::DirectoryCreateParams::Body::OrHash], + request_options: FinchAPI::RequestOptions::OrHash + ).returns(T::Array[T.anything]) end 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 + ) + end + # @api private sig { params(client: FinchAPI::Client).returns(T.attached_class) } - def self.new(client:); end + def self.new(client:) + end end end end diff --git a/rbi/finch_api/resources/sandbox/employment.rbi b/rbi/finch_api/resources/sandbox/employment.rbi index c2eb27b5..66137584 100644 --- a/rbi/finch_api/resources/sandbox/employment.rbi +++ b/rbi/finch_api/resources/sandbox/employment.rbi @@ -9,30 +9,41 @@ module FinchAPI params( individual_id: String, class_code: T.nilable(String), - custom_fields: T::Array[T.any(FinchAPI::Models::Sandbox::EmploymentUpdateParams::CustomField, FinchAPI::Internal::AnyHash)], - department: T.nilable( - T.any(FinchAPI::Models::Sandbox::EmploymentUpdateParams::Department, FinchAPI::Internal::AnyHash) - ), - employment: T.nilable( - T.any(FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment, FinchAPI::Internal::AnyHash) - ), - employment_status: T.nilable(FinchAPI::Models::Sandbox::EmploymentUpdateParams::EmploymentStatus::OrSymbol), + custom_fields: + T::Array[ + FinchAPI::Sandbox::EmploymentUpdateParams::CustomField::OrHash + ], + department: + T.nilable( + FinchAPI::Sandbox::EmploymentUpdateParams::Department::OrHash + ), + employment: + T.nilable( + FinchAPI::Sandbox::EmploymentUpdateParams::Employment::OrHash + ), + employment_status: + T.nilable( + FinchAPI::Sandbox::EmploymentUpdateParams::EmploymentStatus::OrSymbol + ), end_date: T.nilable(String), first_name: T.nilable(String), - income: T.nilable(T.any(FinchAPI::Models::Income, FinchAPI::Internal::AnyHash)), - income_history: T.nilable(T::Array[T.nilable(T.any(FinchAPI::Models::Income, FinchAPI::Internal::AnyHash))]), + income: T.nilable(FinchAPI::Income::OrHash), + income_history: + T.nilable(T::Array[T.nilable(FinchAPI::Income::OrHash)]), 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::Internal::AnyHash)), - manager: T.nilable(T.any(FinchAPI::Models::Sandbox::EmploymentUpdateParams::Manager, FinchAPI::Internal::AnyHash)), + location: T.nilable(FinchAPI::Location::OrHash), + manager: + T.nilable( + FinchAPI::Sandbox::EmploymentUpdateParams::Manager::OrHash + ), middle_name: T.nilable(String), source_id: String, start_date: T.nilable(String), title: T.nilable(String), - request_options: FinchAPI::RequestOpts - ) - .returns(FinchAPI::Models::Sandbox::EmploymentUpdateResponse) + request_options: FinchAPI::RequestOptions::OrHash + ).returns(FinchAPI::Models::Sandbox::EmploymentUpdateResponse) end def update( individual_id, @@ -73,10 +84,13 @@ module FinchAPI # The current title of the individual. title: nil, request_options: {} - ); end + ) + end + # @api private sig { params(client: FinchAPI::Client).returns(T.attached_class) } - def self.new(client:); end + def self.new(client:) + end end end end diff --git a/rbi/finch_api/resources/sandbox/individual.rbi b/rbi/finch_api/resources/sandbox/individual.rbi index a7a1ff98..9aee0d3e 100644 --- a/rbi/finch_api/resources/sandbox/individual.rbi +++ b/rbi/finch_api/resources/sandbox/individual.rbi @@ -9,28 +9,37 @@ module FinchAPI params( individual_id: String, dob: T.nilable(String), - emails: T.nilable( - T::Array[T.any(FinchAPI::Models::Sandbox::IndividualUpdateParams::Email, FinchAPI::Internal::AnyHash)] - ), + emails: + T.nilable( + T::Array[ + FinchAPI::Sandbox::IndividualUpdateParams::Email::OrHash + ] + ), encrypted_ssn: T.nilable(String), - ethnicity: T.nilable(FinchAPI::Models::Sandbox::IndividualUpdateParams::Ethnicity::OrSymbol), + ethnicity: + T.nilable( + FinchAPI::Sandbox::IndividualUpdateParams::Ethnicity::OrSymbol + ), first_name: T.nilable(String), - gender: T.nilable(FinchAPI::Models::Sandbox::IndividualUpdateParams::Gender::OrSymbol), + gender: + T.nilable( + FinchAPI::Sandbox::IndividualUpdateParams::Gender::OrSymbol + ), last_name: T.nilable(String), middle_name: T.nilable(String), - phone_numbers: T.nilable( - T::Array[ - T.nilable( - T.any(FinchAPI::Models::Sandbox::IndividualUpdateParams::PhoneNumber, FinchAPI::Internal::AnyHash) - ) - ] - ), + phone_numbers: + T.nilable( + T::Array[ + T.nilable( + FinchAPI::Sandbox::IndividualUpdateParams::PhoneNumber::OrHash + ) + ] + ), preferred_name: T.nilable(String), - residence: T.nilable(T.any(FinchAPI::Models::Location, FinchAPI::Internal::AnyHash)), + residence: T.nilable(FinchAPI::Location::OrHash), ssn: T.nilable(String), - request_options: FinchAPI::RequestOpts - ) - .returns(FinchAPI::Models::Sandbox::IndividualUpdateResponse) + request_options: FinchAPI::RequestOptions::OrHash + ).returns(FinchAPI::Models::Sandbox::IndividualUpdateResponse) end def update( individual_id, @@ -60,10 +69,13 @@ module FinchAPI # [Click here to learn more about enabling the SSN field](/developer-resources/Enable-SSN-Field). ssn: nil, request_options: {} - ); end + ) + end + # @api private sig { params(client: FinchAPI::Client).returns(T.attached_class) } - def self.new(client:); end + def self.new(client:) + end end end end diff --git a/rbi/finch_api/resources/sandbox/jobs.rbi b/rbi/finch_api/resources/sandbox/jobs.rbi index 90cc1e68..43104e53 100644 --- a/rbi/finch_api/resources/sandbox/jobs.rbi +++ b/rbi/finch_api/resources/sandbox/jobs.rbi @@ -10,19 +10,21 @@ module FinchAPI # Enqueue a new sandbox job sig do params( - type: FinchAPI::Models::Sandbox::JobCreateParams::Type::OrSymbol, - request_options: FinchAPI::RequestOpts - ) - .returns(FinchAPI::Models::Sandbox::JobCreateResponse) + type: FinchAPI::Sandbox::JobCreateParams::Type::OrSymbol, + request_options: FinchAPI::RequestOptions::OrHash + ).returns(FinchAPI::Models::Sandbox::JobCreateResponse) end def create( # The type of job to start. Currently the only supported type is `data_sync_all` type:, request_options: {} - ); end + ) + end + # @api private sig { params(client: FinchAPI::Client).returns(T.attached_class) } - def self.new(client:); end + def self.new(client:) + end end end end diff --git a/rbi/finch_api/resources/sandbox/jobs/configuration.rbi b/rbi/finch_api/resources/sandbox/jobs/configuration.rbi index e7acc227..26279cf1 100644 --- a/rbi/finch_api/resources/sandbox/jobs/configuration.rbi +++ b/rbi/finch_api/resources/sandbox/jobs/configuration.rbi @@ -7,25 +7,30 @@ module FinchAPI class Configuration # Get configurations for sandbox jobs sig do - params(request_options: FinchAPI::RequestOpts) - .returns(T::Array[FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration]) + params(request_options: FinchAPI::RequestOptions::OrHash).returns( + T::Array[FinchAPI::Sandbox::Jobs::SandboxJobConfiguration] + ) + end + def retrieve(request_options: {}) end - def retrieve(request_options: {}); end # Update configurations for sandbox jobs sig do params( - completion_status: FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration::CompletionStatus::OrSymbol, - type: FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration::Type::OrSymbol, - request_options: FinchAPI::RequestOpts - ) - .returns(FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration) + completion_status: + FinchAPI::Sandbox::Jobs::SandboxJobConfiguration::CompletionStatus::OrSymbol, + type: + FinchAPI::Sandbox::Jobs::SandboxJobConfiguration::Type::OrSymbol, + request_options: FinchAPI::RequestOptions::OrHash + ).returns(FinchAPI::Sandbox::Jobs::SandboxJobConfiguration) + end + def update(completion_status:, type:, request_options: {}) end - def update(completion_status:, type:, request_options: {}); end # @api private sig { params(client: FinchAPI::Client).returns(T.attached_class) } - def self.new(client:); end + def self.new(client:) + end end end end diff --git a/rbi/finch_api/resources/sandbox/payment.rbi b/rbi/finch_api/resources/sandbox/payment.rbi index f2b57247..4afcb852 100644 --- a/rbi/finch_api/resources/sandbox/payment.rbi +++ b/rbi/finch_api/resources/sandbox/payment.rbi @@ -8,17 +8,26 @@ module FinchAPI sig do params( end_date: String, - pay_statements: T::Array[T.any(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement, FinchAPI::Internal::AnyHash)], + pay_statements: + T::Array[ + FinchAPI::Sandbox::PaymentCreateParams::PayStatement::OrHash + ], start_date: String, - request_options: FinchAPI::RequestOpts - ) - .returns(FinchAPI::Models::Sandbox::PaymentCreateResponse) + request_options: FinchAPI::RequestOptions::OrHash + ).returns(FinchAPI::Models::Sandbox::PaymentCreateResponse) + end + def create( + end_date: nil, + pay_statements: nil, + start_date: nil, + request_options: {} + ) end - def create(end_date: nil, pay_statements: nil, start_date: nil, request_options: {}); end # @api private sig { params(client: FinchAPI::Client).returns(T.attached_class) } - def self.new(client:); end + def self.new(client:) + end end end end diff --git a/rbi/finch_api/resources/webhooks.rbi b/rbi/finch_api/resources/webhooks.rbi index 2da7fe6d..10670e8d 100644 --- a/rbi/finch_api/resources/webhooks.rbi +++ b/rbi/finch_api/resources/webhooks.rbi @@ -5,7 +5,8 @@ module FinchAPI class Webhooks # @api private sig { params(client: FinchAPI::Client).returns(T.attached_class) } - def self.new(client:); end + def self.new(client:) + end end end end diff --git a/sig/finch_api/internal/individuals_page.rbs b/sig/finch_api/internal/individuals_page.rbs index 77b6be1b..aa96320b 100644 --- a/sig/finch_api/internal/individuals_page.rbs +++ b/sig/finch_api/internal/individuals_page.rbs @@ -5,7 +5,7 @@ module FinchAPI attr_accessor individuals: ::Array[Elem]? - attr_accessor paging: FinchAPI::Models::Paging + attr_accessor paging: FinchAPI::Paging def inspect: -> String end diff --git a/sig/finch_api/internal/page.rbs b/sig/finch_api/internal/page.rbs index 0593bdf7..c22d778c 100644 --- a/sig/finch_api/internal/page.rbs +++ b/sig/finch_api/internal/page.rbs @@ -5,7 +5,7 @@ module FinchAPI attr_accessor data: ::Array[Elem]? - attr_accessor paging: FinchAPI::Models::Paging + attr_accessor paging: FinchAPI::Paging def inspect: -> String end diff --git a/sig/finch_api/internal/type/request_parameters.rbs b/sig/finch_api/internal/type/request_parameters.rbs index 8319dcd2..310e18ff 100644 --- a/sig/finch_api/internal/type/request_parameters.rbs +++ b/sig/finch_api/internal/type/request_parameters.rbs @@ -4,7 +4,9 @@ module FinchAPI type request_parameters = { request_options: FinchAPI::request_opts } module RequestParameters - attr_accessor request_options: FinchAPI::request_opts + attr_reader request_options: FinchAPI::request_opts + + def request_options=: (FinchAPI::request_opts) -> FinchAPI::request_opts module Converter def dump_request: (top params) -> [top, ::Hash[Symbol, top]] diff --git a/sig/finch_api/internal/util.rbs b/sig/finch_api/internal/util.rbs index c8dbe6cf..c9605c99 100644 --- a/sig/finch_api/internal/util.rbs +++ b/sig/finch_api/internal/util.rbs @@ -19,6 +19,8 @@ module FinchAPI def self?.coerce_hash: (top input) -> (::Hash[top, top] | top) + def self?.coerce_hash!: (top input) -> ::Hash[top, top]? + def self?.deep_merge_lr: (top lhs, top rhs, ?concat: bool) -> top def self?.deep_merge: ( diff --git a/sig/finch_api/models.rbs b/sig/finch_api/models.rbs new file mode 100644 index 00000000..d6b14bd9 --- /dev/null +++ b/sig/finch_api/models.rbs @@ -0,0 +1,63 @@ +module FinchAPI + class AccessTokenCreateParams = FinchAPI::Models::AccessTokenCreateParams + + class AccountDisconnectParams = FinchAPI::Models::AccountDisconnectParams + + class AccountIntrospectParams = FinchAPI::Models::AccountIntrospectParams + + class AccountUpdateEvent = FinchAPI::Models::AccountUpdateEvent + + class BaseWebhookEvent = FinchAPI::Models::BaseWebhookEvent + + class CompanyEvent = FinchAPI::Models::CompanyEvent + + module Connect = FinchAPI::Models::Connect + + module ConnectionStatusType = FinchAPI::Models::ConnectionStatusType + + class CreateAccessTokenResponse = FinchAPI::Models::CreateAccessTokenResponse + + class DirectoryEvent = FinchAPI::Models::DirectoryEvent + + class DisconnectResponse = FinchAPI::Models::DisconnectResponse + + class EmploymentEvent = FinchAPI::Models::EmploymentEvent + + module HRIS = FinchAPI::Models::HRIS + + class Income = FinchAPI::Models::Income + + class IndividualEvent = FinchAPI::Models::IndividualEvent + + class Introspection = FinchAPI::Models::Introspection + + class JobCompletionEvent = FinchAPI::Models::JobCompletionEvent + + module Jobs = FinchAPI::Models::Jobs + + class Location = FinchAPI::Models::Location + + class Money = FinchAPI::Models::Money + + module OperationSupport = FinchAPI::Models::OperationSupport + + class OperationSupportMatrix = FinchAPI::Models::OperationSupportMatrix + + class Paging = FinchAPI::Models::Paging + + class PaymentEvent = FinchAPI::Models::PaymentEvent + + module Payroll = FinchAPI::Models::Payroll + + class PayStatementEvent = FinchAPI::Models::PayStatementEvent + + class Provider = FinchAPI::Models::Provider + + class ProviderListParams = FinchAPI::Models::ProviderListParams + + class RequestForwardingForwardParams = FinchAPI::Models::RequestForwardingForwardParams + + module Sandbox = FinchAPI::Models::Sandbox + + module WebhookEvent = FinchAPI::Models::WebhookEvent +end diff --git a/sig/finch_api/models/access_token_create_params.rbs b/sig/finch_api/models/access_token_create_params.rbs index 59104771..f67548e2 100644 --- a/sig/finch_api/models/access_token_create_params.rbs +++ b/sig/finch_api/models/access_token_create_params.rbs @@ -34,8 +34,6 @@ module FinchAPI ?redirect_uri: String, ?request_options: FinchAPI::request_opts ) -> void - - def to_hash: -> FinchAPI::Models::access_token_create_params end end end diff --git a/sig/finch_api/models/account_disconnect_params.rbs b/sig/finch_api/models/account_disconnect_params.rbs index e67ae70f..7e9dcc1c 100644 --- a/sig/finch_api/models/account_disconnect_params.rbs +++ b/sig/finch_api/models/account_disconnect_params.rbs @@ -8,8 +8,6 @@ module FinchAPI include FinchAPI::Internal::Type::RequestParameters def initialize: (?request_options: FinchAPI::request_opts) -> void - - def to_hash: -> FinchAPI::Models::account_disconnect_params end end end diff --git a/sig/finch_api/models/account_introspect_params.rbs b/sig/finch_api/models/account_introspect_params.rbs index bc1901ff..d6f92f47 100644 --- a/sig/finch_api/models/account_introspect_params.rbs +++ b/sig/finch_api/models/account_introspect_params.rbs @@ -8,8 +8,6 @@ module FinchAPI include FinchAPI::Internal::Type::RequestParameters def initialize: (?request_options: FinchAPI::request_opts) -> void - - def to_hash: -> FinchAPI::Models::account_introspect_params end end end diff --git a/sig/finch_api/models/account_update_event.rbs b/sig/finch_api/models/account_update_event.rbs index 7117b51f..32a7a1ac 100644 --- a/sig/finch_api/models/account_update_event.rbs +++ b/sig/finch_api/models/account_update_event.rbs @@ -2,149 +2,141 @@ module FinchAPI module Models type account_update_event = { - data: FinchAPI::Models::AccountUpdateEvent::Data, - event_type: FinchAPI::Models::AccountUpdateEvent::event_type + data: FinchAPI::AccountUpdateEvent::Data, + event_type: FinchAPI::AccountUpdateEvent::event_type } class AccountUpdateEvent < FinchAPI::Models::BaseWebhookEvent - def data: -> FinchAPI::Models::AccountUpdateEvent::Data? + def data: -> FinchAPI::AccountUpdateEvent::Data? def data=: ( - FinchAPI::Models::AccountUpdateEvent::Data _ - ) -> FinchAPI::Models::AccountUpdateEvent::Data + FinchAPI::AccountUpdateEvent::Data _ + ) -> FinchAPI::AccountUpdateEvent::Data - def event_type: -> FinchAPI::Models::AccountUpdateEvent::event_type? + def event_type: -> FinchAPI::AccountUpdateEvent::event_type? def event_type=: ( - FinchAPI::Models::AccountUpdateEvent::event_type _ - ) -> FinchAPI::Models::AccountUpdateEvent::event_type + FinchAPI::AccountUpdateEvent::event_type _ + ) -> FinchAPI::AccountUpdateEvent::event_type def initialize: ( - ?data: FinchAPI::Models::AccountUpdateEvent::Data, - ?event_type: FinchAPI::Models::AccountUpdateEvent::event_type + ?data: FinchAPI::AccountUpdateEvent::Data, + ?event_type: FinchAPI::AccountUpdateEvent::event_type ) -> void - def to_hash: -> FinchAPI::Models::account_update_event - type data = { - authentication_method: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod, + authentication_method: FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod, status: FinchAPI::Models::connection_status_type } class Data < FinchAPI::Internal::Type::BaseModel - attr_accessor authentication_method: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod + attr_accessor authentication_method: FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod attr_accessor status: FinchAPI::Models::connection_status_type def initialize: ( - authentication_method: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod, + authentication_method: FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod, status: FinchAPI::Models::connection_status_type ) -> void - def to_hash: -> FinchAPI::Models::AccountUpdateEvent::data - type authentication_method = { - benefits_support: FinchAPI::Models::HRIS::BenefitsSupport?, - supported_fields: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields?, - type: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::type_ + benefits_support: FinchAPI::HRIS::BenefitsSupport?, + supported_fields: FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields?, + type: FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::type_ } class AuthenticationMethod < FinchAPI::Internal::Type::BaseModel - attr_accessor benefits_support: FinchAPI::Models::HRIS::BenefitsSupport? + attr_accessor benefits_support: FinchAPI::HRIS::BenefitsSupport? - attr_accessor supported_fields: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields? + attr_accessor supported_fields: FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields? - attr_reader type: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::type_? + attr_reader type: FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::type_? def type=: ( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::type_ - ) -> FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::type_ + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::type_ + ) -> FinchAPI::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_ + ?benefits_support: FinchAPI::HRIS::BenefitsSupport?, + ?supported_fields: FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields?, + ?type: FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::type_ ) -> void - def to_hash: -> FinchAPI::Models::AccountUpdateEvent::Data::authentication_method - type supported_fields = { - 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::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company, + directory: FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory, + employment: FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment, + individual: FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual, + pay_group: FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayGroup, + pay_statement: FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement, + payment: FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Payment } class SupportedFields < FinchAPI::Internal::Type::BaseModel - attr_reader company: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company? + attr_reader company: FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company? def company=: ( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company - ) -> FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company + ) -> FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company - attr_reader directory: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory? + attr_reader directory: FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory? def directory=: ( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory - ) -> FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory + ) -> FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory - attr_reader employment: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment? + attr_reader employment: FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment? def employment=: ( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment - ) -> FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment + ) -> FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment - attr_reader individual: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual? + attr_reader individual: FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual? def individual=: ( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual - ) -> FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual + ) -> FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual - attr_reader pay_group: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayGroup? + attr_reader pay_group: FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayGroup? def pay_group=: ( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayGroup - ) -> FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayGroup + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayGroup + ) -> FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayGroup - attr_reader pay_statement: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement? + attr_reader pay_statement: FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement? def pay_statement=: ( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement - ) -> FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement + ) -> FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement - attr_reader payment: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Payment? + attr_reader payment: FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Payment? def payment=: ( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Payment - ) -> FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Payment + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Payment + ) -> FinchAPI::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 + ?company: FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company, + ?directory: FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory, + ?employment: FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment, + ?individual: FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual, + ?pay_group: FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayGroup, + ?pay_statement: FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement, + ?payment: FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Payment ) -> void - def to_hash: -> FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::supported_fields - type company = { id: bool, - accounts: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Accounts, - departments: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Departments, + accounts: FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Accounts, + departments: FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Departments, ein: bool, - entity: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Entity, + entity: FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Entity, legal_name: bool, - locations: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Locations, + locations: FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Locations, primary_email: bool, primary_phone_number: bool } @@ -154,37 +146,37 @@ module FinchAPI def id=: (bool) -> bool - attr_reader accounts: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Accounts? + attr_reader accounts: FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Accounts? def accounts=: ( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Accounts - ) -> FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Accounts + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Accounts + ) -> FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Accounts - attr_reader departments: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Departments? + attr_reader departments: FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Departments? def departments=: ( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Departments - ) -> FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Departments + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Departments + ) -> FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Departments attr_reader ein: bool? def ein=: (bool) -> bool - attr_reader entity: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Entity? + attr_reader entity: FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Entity? def entity=: ( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Entity - ) -> FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Entity + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Entity + ) -> FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Entity attr_reader legal_name: bool? def legal_name=: (bool) -> bool - attr_reader locations: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Locations? + attr_reader locations: FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Locations? def locations=: ( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Locations - ) -> FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Locations + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Locations + ) -> FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Locations attr_reader primary_email: bool? @@ -196,18 +188,16 @@ module FinchAPI def initialize: ( ?id: bool, - ?accounts: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Accounts, - ?departments: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Departments, + ?accounts: FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Accounts, + ?departments: FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Departments, ?ein: bool, - ?entity: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Entity, + ?entity: FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Entity, ?legal_name: bool, - ?locations: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Locations, + ?locations: FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Locations, ?primary_email: bool, ?primary_phone_number: bool ) -> void - def to_hash: -> FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::company - type accounts = { account_name: bool, @@ -245,14 +235,12 @@ module FinchAPI ?institution_name: bool, ?routing_number: bool ) -> void - - def to_hash: -> FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::accounts end type departments = { name: bool, - parent: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Departments::Parent + parent: FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Departments::Parent } class Departments < FinchAPI::Internal::Type::BaseModel @@ -260,19 +248,17 @@ module FinchAPI def name=: (bool) -> bool - attr_reader parent: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Departments::Parent? + attr_reader parent: FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Departments::Parent? def parent=: ( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Departments::Parent - ) -> FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Departments::Parent + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Departments::Parent + ) -> FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Departments::Parent def initialize: ( ?name: bool, - ?parent: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Departments::Parent + ?parent: FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Departments::Parent ) -> void - def to_hash: -> FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::departments - type parent = { name: bool } class Parent < FinchAPI::Internal::Type::BaseModel @@ -281,8 +267,6 @@ module FinchAPI def name=: (bool) -> bool def initialize: (?name: bool) -> void - - def to_hash: -> FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Departments::parent end end @@ -298,8 +282,6 @@ module FinchAPI def type=: (bool) -> bool def initialize: (?subtype: bool, ?type: bool) -> void - - def to_hash: -> FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::entity end type locations = @@ -345,37 +327,33 @@ module FinchAPI ?postal_code: bool, ?state: bool ) -> void - - def to_hash: -> FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::locations end end type directory = { - individuals: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory::Individuals, - paging: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory::Paging + individuals: FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory::Individuals, + paging: FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory::Paging } class Directory < FinchAPI::Internal::Type::BaseModel - attr_reader individuals: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory::Individuals? + attr_reader individuals: FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory::Individuals? def individuals=: ( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory::Individuals - ) -> FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory::Individuals + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory::Individuals + ) -> FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory::Individuals - attr_reader paging: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory::Paging? + attr_reader paging: FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory::Paging? def paging=: ( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory::Paging - ) -> FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory::Paging + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory::Paging + ) -> FinchAPI::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 + ?individuals: FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory::Individuals, + ?paging: FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory::Paging ) -> void - def to_hash: -> FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::directory - type individuals = { id: bool, @@ -383,7 +361,7 @@ module FinchAPI first_name: bool, is_active: bool, last_name: bool, - manager: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory::Individuals::Manager, + manager: FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory::Individuals::Manager, middle_name: bool } @@ -408,11 +386,11 @@ module FinchAPI def last_name=: (bool) -> bool - attr_reader manager: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory::Individuals::Manager? + attr_reader manager: FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory::Individuals::Manager? def manager=: ( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory::Individuals::Manager - ) -> FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory::Individuals::Manager + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory::Individuals::Manager + ) -> FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory::Individuals::Manager attr_reader middle_name: bool? @@ -424,12 +402,10 @@ module FinchAPI ?first_name: bool, ?is_active: bool, ?last_name: bool, - ?manager: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory::Individuals::Manager, + ?manager: FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory::Individuals::Manager, ?middle_name: bool ) -> void - def to_hash: -> FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory::individuals - type manager = { id: bool } class Manager < FinchAPI::Internal::Type::BaseModel @@ -438,8 +414,6 @@ module FinchAPI def id=: (bool) -> bool def initialize: (?id: bool) -> void - - def to_hash: -> FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory::Individuals::manager end end @@ -455,8 +429,6 @@ module FinchAPI def offset=: (bool) -> bool def initialize: (?count: bool, ?offset: bool) -> void - - def to_hash: -> FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory::paging end end @@ -465,17 +437,17 @@ module FinchAPI 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, + department: FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Department, + employment: FinchAPI::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: FinchAPI::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, + location: FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Location, + manager: FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Manager, middle_name: bool, start_date: bool, title: bool @@ -494,17 +466,17 @@ module FinchAPI def custom_fields=: (bool) -> bool - attr_reader department: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Department? + attr_reader department: FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Department? def department=: ( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Department - ) -> FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Department + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Department + ) -> FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Department - attr_reader employment: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Employment? + attr_reader employment: FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Employment? def employment=: ( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Employment - ) -> FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Employment + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Employment + ) -> FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Employment attr_reader employment_status: bool? @@ -518,11 +490,11 @@ module FinchAPI def first_name=: (bool) -> bool - attr_reader income: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Income? + attr_reader income: FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Income? def income=: ( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Income - ) -> FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Income + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Income + ) -> FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Income attr_reader income_history: bool? @@ -536,17 +508,17 @@ module FinchAPI def last_name=: (bool) -> bool - attr_reader location: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Location? + attr_reader location: FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Location? def location=: ( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Location - ) -> FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Location + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Location + ) -> FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Location - attr_reader manager: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Manager? + attr_reader manager: FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Manager? def manager=: ( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Manager - ) -> FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Manager + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Manager + ) -> FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Manager attr_reader middle_name: bool? @@ -564,24 +536,22 @@ module FinchAPI ?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, + ?department: FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Department, + ?employment: FinchAPI::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: FinchAPI::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, + ?location: FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Location, + ?manager: FinchAPI::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 - type department = { name: bool } class Department < FinchAPI::Internal::Type::BaseModel @@ -590,8 +560,6 @@ module FinchAPI def name=: (bool) -> bool def initialize: (?name: bool) -> void - - def to_hash: -> FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::department end type employment = { subtype: bool, type: bool } @@ -606,8 +574,6 @@ module FinchAPI def type=: (bool) -> bool def initialize: (?subtype: bool, ?type: bool) -> void - - def to_hash: -> FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::employment end type income = { amount: bool, currency: bool, unit: bool } @@ -630,8 +596,6 @@ module FinchAPI ?currency: bool, ?unit: bool ) -> void - - def to_hash: -> FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::income end type location = @@ -677,8 +641,6 @@ module FinchAPI ?postal_code: bool, ?state: bool ) -> void - - def to_hash: -> FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::location end type manager = { id: bool } @@ -689,8 +651,6 @@ module FinchAPI def id=: (bool) -> bool def initialize: (?id: bool) -> void - - def to_hash: -> FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::manager end end @@ -698,16 +658,16 @@ module FinchAPI { id: bool, dob: bool, - emails: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual::Emails, + emails: FinchAPI::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, + phone_numbers: FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual::PhoneNumbers, preferred_name: bool, - residence: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual::Residence, + residence: FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual::Residence, ssn: bool } @@ -720,11 +680,11 @@ module FinchAPI def dob=: (bool) -> bool - attr_reader emails: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual::Emails? + attr_reader emails: FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual::Emails? def emails=: ( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual::Emails - ) -> FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual::Emails + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual::Emails + ) -> FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual::Emails attr_reader encrypted_ssn: bool? @@ -750,21 +710,21 @@ module FinchAPI def middle_name=: (bool) -> bool - attr_reader phone_numbers: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual::PhoneNumbers? + attr_reader phone_numbers: FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual::PhoneNumbers? def phone_numbers=: ( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual::PhoneNumbers - ) -> FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual::PhoneNumbers + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual::PhoneNumbers + ) -> FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual::PhoneNumbers attr_reader preferred_name: bool? def preferred_name=: (bool) -> bool - attr_reader residence: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual::Residence? + attr_reader residence: FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual::Residence? def residence=: ( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual::Residence - ) -> FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual::Residence + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual::Residence + ) -> FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual::Residence attr_reader ssn: bool? @@ -773,21 +733,19 @@ module FinchAPI def initialize: ( ?id: bool, ?dob: bool, - ?emails: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual::Emails, + ?emails: FinchAPI::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, + ?phone_numbers: FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual::PhoneNumbers, ?preferred_name: bool, - ?residence: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual::Residence, + ?residence: FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual::Residence, ?ssn: bool ) -> void - def to_hash: -> FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::individual - type emails = { data: bool, type: bool } class Emails < FinchAPI::Internal::Type::BaseModel @@ -800,8 +758,6 @@ module FinchAPI def type=: (bool) -> bool def initialize: (?data: bool, ?type: bool) -> void - - def to_hash: -> FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual::emails end type phone_numbers = { data: bool, type: bool } @@ -816,8 +772,6 @@ module FinchAPI def type=: (bool) -> bool def initialize: (?data: bool, ?type: bool) -> void - - def to_hash: -> FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual::phone_numbers end type residence = @@ -863,8 +817,6 @@ module FinchAPI ?postal_code: bool, ?state: bool ) -> void - - def to_hash: -> FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual::residence end end @@ -899,36 +851,32 @@ module FinchAPI ?name: bool, ?pay_frequencies: bool ) -> void - - def to_hash: -> FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::pay_group end type pay_statement = { - paging: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::Paging, - pay_statements: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements + paging: FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::Paging, + pay_statements: FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements } class PayStatement < FinchAPI::Internal::Type::BaseModel - attr_reader paging: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::Paging? + attr_reader paging: FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::Paging? def paging=: ( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::Paging - ) -> FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::Paging + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::Paging + ) -> FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::Paging - attr_reader pay_statements: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements? + attr_reader pay_statements: FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements? def pay_statements=: ( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements - ) -> FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements + ) -> FinchAPI::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 + ?paging: FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::Paging, + ?pay_statements: FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements ) -> void - def to_hash: -> FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::pay_statement - type paging = { count: bool, offset: bool } class Paging < FinchAPI::Internal::Type::BaseModel @@ -937,42 +885,40 @@ module FinchAPI attr_accessor offset: bool def initialize: (count: bool, offset: bool) -> void - - def to_hash: -> FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::paging end type pay_statements = { - 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: FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Earnings, + employee_deductions: FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployeeDeductions, + employer_contributions: FinchAPI::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, + taxes: FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Taxes, total_hours: bool, type: bool } class PayStatements < FinchAPI::Internal::Type::BaseModel - attr_reader earnings: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Earnings? + attr_reader earnings: FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Earnings? def earnings=: ( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Earnings - ) -> FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Earnings + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Earnings + ) -> FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Earnings - attr_reader employee_deductions: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployeeDeductions? + attr_reader employee_deductions: FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployeeDeductions? def employee_deductions=: ( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployeeDeductions - ) -> FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployeeDeductions + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployeeDeductions + ) -> FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployeeDeductions - attr_reader employer_contributions: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployerContributions? + attr_reader employer_contributions: FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployerContributions? def employer_contributions=: ( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployerContributions - ) -> FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployerContributions + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployerContributions + ) -> FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployerContributions attr_reader gross_pay: bool? @@ -990,11 +936,11 @@ module FinchAPI def payment_method=: (bool) -> bool - attr_reader taxes: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Taxes? + attr_reader taxes: FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Taxes? def taxes=: ( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Taxes - ) -> FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Taxes + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Taxes + ) -> FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Taxes attr_reader total_hours: bool? @@ -1005,20 +951,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, + ?earnings: FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Earnings, + ?employee_deductions: FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployeeDeductions, + ?employer_contributions: FinchAPI::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, + ?taxes: FinchAPI::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 - type earnings = { amount: bool, currency: bool, name: bool, type: bool } @@ -1045,8 +989,6 @@ module FinchAPI ?name: bool, ?type: bool ) -> void - - def to_hash: -> FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::earnings end type employee_deductions = @@ -1086,8 +1028,6 @@ module FinchAPI ?pre_tax: bool, ?type: bool ) -> void - - def to_hash: -> FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::employee_deductions end type employer_contributions = @@ -1111,8 +1051,6 @@ module FinchAPI ?currency: bool, ?name: bool ) -> void - - def to_hash: -> FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::employer_contributions end type taxes = @@ -1152,8 +1090,6 @@ module FinchAPI ?name: bool, ?type: bool ) -> void - - def to_hash: -> FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::taxes end end end @@ -1171,7 +1107,7 @@ module FinchAPI pay_date: bool, pay_frequencies: bool, pay_group_ids: bool, - pay_period: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Payment::PayPeriod + pay_period: FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Payment::PayPeriod } class Payment < FinchAPI::Internal::Type::BaseModel @@ -1219,11 +1155,11 @@ module FinchAPI def pay_group_ids=: (bool) -> bool - attr_reader pay_period: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Payment::PayPeriod? + attr_reader pay_period: FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Payment::PayPeriod? def pay_period=: ( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Payment::PayPeriod - ) -> FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Payment::PayPeriod + FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Payment::PayPeriod + ) -> FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Payment::PayPeriod def initialize: ( ?id: bool, @@ -1237,11 +1173,9 @@ module FinchAPI ?pay_date: bool, ?pay_frequencies: bool, ?pay_group_ids: bool, - ?pay_period: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Payment::PayPeriod + ?pay_period: FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Payment::PayPeriod ) -> void - def to_hash: -> FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::payment - type pay_period = { end_date: bool, start_date: bool } class PayPeriod < FinchAPI::Internal::Type::BaseModel @@ -1254,8 +1188,6 @@ module FinchAPI def start_date=: (bool) -> bool def initialize: (?end_date: bool, ?start_date: bool) -> void - - def to_hash: -> FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Payment::pay_period end end end @@ -1272,7 +1204,7 @@ module FinchAPI API_CREDENTIAL: :api_credential OAUTH: :oauth - def self?.values: -> ::Array[FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::type_] + def self?.values: -> ::Array[FinchAPI::AccountUpdateEvent::Data::AuthenticationMethod::type_] end end end @@ -1284,7 +1216,7 @@ module FinchAPI ACCOUNT_UPDATED: :"account.updated" - def self?.values: -> ::Array[FinchAPI::Models::AccountUpdateEvent::event_type] + def self?.values: -> ::Array[FinchAPI::AccountUpdateEvent::event_type] end end end diff --git a/sig/finch_api/models/base_webhook_event.rbs b/sig/finch_api/models/base_webhook_event.rbs index 9ddc8d53..44b19717 100644 --- a/sig/finch_api/models/base_webhook_event.rbs +++ b/sig/finch_api/models/base_webhook_event.rbs @@ -17,8 +17,6 @@ module FinchAPI company_id: String, ?connection_id: String ) -> void - - def to_hash: -> FinchAPI::Models::base_webhook_event end end end diff --git a/sig/finch_api/models/company_event.rbs b/sig/finch_api/models/company_event.rbs index 1670296f..5389b6c7 100644 --- a/sig/finch_api/models/company_event.rbs +++ b/sig/finch_api/models/company_event.rbs @@ -3,7 +3,7 @@ module FinchAPI type company_event = { data: ::Hash[Symbol, top]?, - event_type: FinchAPI::Models::CompanyEvent::event_type + event_type: FinchAPI::CompanyEvent::event_type } class CompanyEvent < FinchAPI::Models::BaseWebhookEvent @@ -11,19 +11,17 @@ module FinchAPI def data=: (::Hash[Symbol, top]? _) -> ::Hash[Symbol, top]? - def event_type: -> FinchAPI::Models::CompanyEvent::event_type? + def event_type: -> FinchAPI::CompanyEvent::event_type? def event_type=: ( - FinchAPI::Models::CompanyEvent::event_type _ - ) -> FinchAPI::Models::CompanyEvent::event_type + FinchAPI::CompanyEvent::event_type _ + ) -> FinchAPI::CompanyEvent::event_type def initialize: ( ?data: ::Hash[Symbol, top]?, - ?event_type: FinchAPI::Models::CompanyEvent::event_type + ?event_type: FinchAPI::CompanyEvent::event_type ) -> void - def to_hash: -> FinchAPI::Models::company_event - type event_type = :"company.updated" module EventType @@ -31,7 +29,7 @@ module FinchAPI COMPANY_UPDATED: :"company.updated" - def self?.values: -> ::Array[FinchAPI::Models::CompanyEvent::event_type] + def self?.values: -> ::Array[FinchAPI::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 b1e1b6a5..2cfe4f8c 100644 --- a/sig/finch_api/models/connect/session_new_params.rbs +++ b/sig/finch_api/models/connect/session_new_params.rbs @@ -5,9 +5,9 @@ module FinchAPI { customer_id: String, customer_name: String, - products: ::Array[FinchAPI::Models::Connect::SessionNewParams::product], + products: ::Array[FinchAPI::Connect::SessionNewParams::product], customer_email: String?, - integration: FinchAPI::Models::Connect::SessionNewParams::Integration?, + integration: FinchAPI::Connect::SessionNewParams::Integration?, manual: bool?, minutes_to_expire: Float?, redirect_uri: String?, @@ -23,11 +23,11 @@ module FinchAPI attr_accessor customer_name: String - attr_accessor products: ::Array[FinchAPI::Models::Connect::SessionNewParams::product] + attr_accessor products: ::Array[FinchAPI::Connect::SessionNewParams::product] attr_accessor customer_email: String? - attr_accessor integration: FinchAPI::Models::Connect::SessionNewParams::Integration? + attr_accessor integration: FinchAPI::Connect::SessionNewParams::Integration? attr_accessor manual: bool? @@ -40,9 +40,9 @@ module FinchAPI def initialize: ( customer_id: String, customer_name: String, - products: ::Array[FinchAPI::Models::Connect::SessionNewParams::product], + products: ::Array[FinchAPI::Connect::SessionNewParams::product], ?customer_email: String?, - ?integration: FinchAPI::Models::Connect::SessionNewParams::Integration?, + ?integration: FinchAPI::Connect::SessionNewParams::Integration?, ?manual: bool?, ?minutes_to_expire: Float?, ?redirect_uri: String?, @@ -50,8 +50,6 @@ module FinchAPI ?request_options: FinchAPI::request_opts ) -> void - def to_hash: -> FinchAPI::Models::Connect::session_new_params - type product = :company | :directory @@ -78,27 +76,25 @@ module FinchAPI DEDUCTION: :deduction DOCUMENTS: :documents - def self?.values: -> ::Array[FinchAPI::Models::Connect::SessionNewParams::product] + def self?.values: -> ::Array[FinchAPI::Connect::SessionNewParams::product] end type integration = { - auth_method: FinchAPI::Models::Connect::SessionNewParams::Integration::auth_method?, + auth_method: FinchAPI::Connect::SessionNewParams::Integration::auth_method?, provider: String? } class Integration < FinchAPI::Internal::Type::BaseModel - attr_accessor auth_method: FinchAPI::Models::Connect::SessionNewParams::Integration::auth_method? + attr_accessor auth_method: FinchAPI::Connect::SessionNewParams::Integration::auth_method? attr_accessor provider: String? def initialize: ( - ?auth_method: FinchAPI::Models::Connect::SessionNewParams::Integration::auth_method?, + ?auth_method: FinchAPI::Connect::SessionNewParams::Integration::auth_method?, ?provider: String? ) -> void - def to_hash: -> FinchAPI::Models::Connect::SessionNewParams::integration - type auth_method = :assisted | :credential | :oauth | :api_token module AuthMethod @@ -109,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::Connect::SessionNewParams::Integration::auth_method] end end diff --git a/sig/finch_api/models/connect/session_new_response.rbs b/sig/finch_api/models/connect/session_new_response.rbs index 52641a3e..67b02419 100644 --- a/sig/finch_api/models/connect/session_new_response.rbs +++ b/sig/finch_api/models/connect/session_new_response.rbs @@ -9,8 +9,6 @@ module FinchAPI attr_accessor session_id: String def initialize: (connect_url: String, session_id: String) -> void - - def to_hash: -> FinchAPI::Models::Connect::session_new_response 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 6745d6f8..4760323e 100644 --- a/sig/finch_api/models/connect/session_reauthenticate_params.rbs +++ b/sig/finch_api/models/connect/session_reauthenticate_params.rbs @@ -5,7 +5,7 @@ module FinchAPI { connection_id: String, minutes_to_expire: Integer?, - products: ::Array[FinchAPI::Models::Connect::SessionReauthenticateParams::product]?, + products: ::Array[FinchAPI::Connect::SessionReauthenticateParams::product]?, redirect_uri: String? } & FinchAPI::Internal::Type::request_parameters @@ -18,20 +18,18 @@ module FinchAPI attr_accessor minutes_to_expire: Integer? - attr_accessor products: ::Array[FinchAPI::Models::Connect::SessionReauthenticateParams::product]? + attr_accessor products: ::Array[FinchAPI::Connect::SessionReauthenticateParams::product]? attr_accessor redirect_uri: String? def initialize: ( connection_id: String, ?minutes_to_expire: Integer?, - ?products: ::Array[FinchAPI::Models::Connect::SessionReauthenticateParams::product]?, + ?products: ::Array[FinchAPI::Connect::SessionReauthenticateParams::product]?, ?redirect_uri: String?, ?request_options: FinchAPI::request_opts ) -> void - def to_hash: -> FinchAPI::Models::Connect::session_reauthenticate_params - type product = :company | :directory @@ -58,7 +56,7 @@ module FinchAPI DEDUCTION: :deduction DOCUMENTS: :documents - def self?.values: -> ::Array[FinchAPI::Models::Connect::SessionReauthenticateParams::product] + def self?.values: -> ::Array[FinchAPI::Connect::SessionReauthenticateParams::product] end end end diff --git a/sig/finch_api/models/connect/session_reauthenticate_response.rbs b/sig/finch_api/models/connect/session_reauthenticate_response.rbs index 10db85b7..02cecde2 100644 --- a/sig/finch_api/models/connect/session_reauthenticate_response.rbs +++ b/sig/finch_api/models/connect/session_reauthenticate_response.rbs @@ -10,8 +10,6 @@ module FinchAPI attr_accessor session_id: String def initialize: (connect_url: String, session_id: String) -> void - - def to_hash: -> FinchAPI::Models::Connect::session_reauthenticate_response 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 7517f2f7..d945bf4e 100644 --- a/sig/finch_api/models/create_access_token_response.rbs +++ b/sig/finch_api/models/create_access_token_response.rbs @@ -4,10 +4,10 @@ module FinchAPI { access_token: String, account_id: String, - client_type: FinchAPI::Models::CreateAccessTokenResponse::client_type, + client_type: FinchAPI::CreateAccessTokenResponse::client_type, company_id: String, connection_id: String, - connection_type: FinchAPI::Models::CreateAccessTokenResponse::connection_type, + connection_type: FinchAPI::CreateAccessTokenResponse::connection_type, products: ::Array[String], provider_id: String, customer_id: String?, @@ -19,13 +19,13 @@ module FinchAPI attr_accessor account_id: String - attr_accessor client_type: FinchAPI::Models::CreateAccessTokenResponse::client_type + attr_accessor client_type: FinchAPI::CreateAccessTokenResponse::client_type attr_accessor company_id: String attr_accessor connection_id: String - attr_accessor connection_type: FinchAPI::Models::CreateAccessTokenResponse::connection_type + attr_accessor connection_type: FinchAPI::CreateAccessTokenResponse::connection_type attr_accessor products: ::Array[String] @@ -40,18 +40,16 @@ module FinchAPI def initialize: ( access_token: String, account_id: String, - client_type: FinchAPI::Models::CreateAccessTokenResponse::client_type, + client_type: FinchAPI::CreateAccessTokenResponse::client_type, company_id: String, connection_id: String, - connection_type: FinchAPI::Models::CreateAccessTokenResponse::connection_type, + connection_type: FinchAPI::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 - type client_type = :production | :development | :sandbox module ClientType @@ -61,7 +59,7 @@ module FinchAPI DEVELOPMENT: :development SANDBOX: :sandbox - def self?.values: -> ::Array[FinchAPI::Models::CreateAccessTokenResponse::client_type] + def self?.values: -> ::Array[FinchAPI::CreateAccessTokenResponse::client_type] end type connection_type = :provider | :finch @@ -72,7 +70,7 @@ module FinchAPI PROVIDER: :provider FINCH: :finch - def self?.values: -> ::Array[FinchAPI::Models::CreateAccessTokenResponse::connection_type] + def self?.values: -> ::Array[FinchAPI::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 67d58d67..c671abf7 100644 --- a/sig/finch_api/models/directory_event.rbs +++ b/sig/finch_api/models/directory_event.rbs @@ -2,30 +2,28 @@ module FinchAPI module Models type directory_event = { - data: FinchAPI::Models::DirectoryEvent::Data, - event_type: FinchAPI::Models::DirectoryEvent::event_type + data: FinchAPI::DirectoryEvent::Data, + event_type: FinchAPI::DirectoryEvent::event_type } class DirectoryEvent < FinchAPI::Models::BaseWebhookEvent - def data: -> FinchAPI::Models::DirectoryEvent::Data? + def data: -> FinchAPI::DirectoryEvent::Data? def data=: ( - FinchAPI::Models::DirectoryEvent::Data _ - ) -> FinchAPI::Models::DirectoryEvent::Data + FinchAPI::DirectoryEvent::Data _ + ) -> FinchAPI::DirectoryEvent::Data - def event_type: -> FinchAPI::Models::DirectoryEvent::event_type? + def event_type: -> FinchAPI::DirectoryEvent::event_type? def event_type=: ( - FinchAPI::Models::DirectoryEvent::event_type _ - ) -> FinchAPI::Models::DirectoryEvent::event_type + FinchAPI::DirectoryEvent::event_type _ + ) -> FinchAPI::DirectoryEvent::event_type def initialize: ( - ?data: FinchAPI::Models::DirectoryEvent::Data, - ?event_type: FinchAPI::Models::DirectoryEvent::event_type + ?data: FinchAPI::DirectoryEvent::Data, + ?event_type: FinchAPI::DirectoryEvent::event_type ) -> void - def to_hash: -> FinchAPI::Models::directory_event - type data = { individual_id: String } class Data < FinchAPI::Internal::Type::BaseModel @@ -34,8 +32,6 @@ module FinchAPI def individual_id=: (String) -> String def initialize: (?individual_id: String) -> void - - def to_hash: -> FinchAPI::Models::DirectoryEvent::data end type event_type = @@ -48,7 +44,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::DirectoryEvent::event_type] end end end diff --git a/sig/finch_api/models/disconnect_response.rbs b/sig/finch_api/models/disconnect_response.rbs index b857221b..f5f47375 100644 --- a/sig/finch_api/models/disconnect_response.rbs +++ b/sig/finch_api/models/disconnect_response.rbs @@ -6,8 +6,6 @@ module FinchAPI attr_accessor status: String def initialize: (status: String) -> void - - def to_hash: -> FinchAPI::Models::disconnect_response end end end diff --git a/sig/finch_api/models/employment_event.rbs b/sig/finch_api/models/employment_event.rbs index 041923b8..501739e5 100644 --- a/sig/finch_api/models/employment_event.rbs +++ b/sig/finch_api/models/employment_event.rbs @@ -2,30 +2,28 @@ module FinchAPI module Models type employment_event = { - data: FinchAPI::Models::EmploymentEvent::Data, - event_type: FinchAPI::Models::EmploymentEvent::event_type + data: FinchAPI::EmploymentEvent::Data, + event_type: FinchAPI::EmploymentEvent::event_type } class EmploymentEvent < FinchAPI::Models::BaseWebhookEvent - def data: -> FinchAPI::Models::EmploymentEvent::Data? + def data: -> FinchAPI::EmploymentEvent::Data? def data=: ( - FinchAPI::Models::EmploymentEvent::Data _ - ) -> FinchAPI::Models::EmploymentEvent::Data + FinchAPI::EmploymentEvent::Data _ + ) -> FinchAPI::EmploymentEvent::Data - def event_type: -> FinchAPI::Models::EmploymentEvent::event_type? + def event_type: -> FinchAPI::EmploymentEvent::event_type? def event_type=: ( - FinchAPI::Models::EmploymentEvent::event_type _ - ) -> FinchAPI::Models::EmploymentEvent::event_type + FinchAPI::EmploymentEvent::event_type _ + ) -> FinchAPI::EmploymentEvent::event_type def initialize: ( - ?data: FinchAPI::Models::EmploymentEvent::Data, - ?event_type: FinchAPI::Models::EmploymentEvent::event_type + ?data: FinchAPI::EmploymentEvent::Data, + ?event_type: FinchAPI::EmploymentEvent::event_type ) -> void - def to_hash: -> FinchAPI::Models::employment_event - type data = { individual_id: String } class Data < FinchAPI::Internal::Type::BaseModel @@ -34,8 +32,6 @@ module FinchAPI def individual_id=: (String) -> String def initialize: (?individual_id: String) -> void - - def to_hash: -> FinchAPI::Models::EmploymentEvent::data end type event_type = @@ -48,7 +44,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::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 54d31b42..2398608b 100644 --- a/sig/finch_api/models/hris/benefit_contribution.rbs +++ b/sig/finch_api/models/hris/benefit_contribution.rbs @@ -2,23 +2,18 @@ module FinchAPI module Models module HRIS type benefit_contribution = - { - amount: Integer?, - type: FinchAPI::Models::HRIS::BenefitContribution::type_? - } + { amount: Integer?, type: FinchAPI::HRIS::BenefitContribution::type_? } class BenefitContribution < FinchAPI::Internal::Type::BaseModel attr_accessor amount: Integer? - attr_accessor type: FinchAPI::Models::HRIS::BenefitContribution::type_? + attr_accessor type: FinchAPI::HRIS::BenefitContribution::type_? def initialize: ( ?amount: Integer?, - ?type: FinchAPI::Models::HRIS::BenefitContribution::type_? + ?type: FinchAPI::HRIS::BenefitContribution::type_? ) -> void - def to_hash: -> FinchAPI::Models::HRIS::benefit_contribution - type type_ = :fixed | :percent module Type @@ -27,7 +22,7 @@ module FinchAPI FIXED: :fixed PERCENT: :percent - def self?.values: -> ::Array[FinchAPI::Models::HRIS::BenefitContribution::type_] + def self?.values: -> ::Array[FinchAPI::HRIS::BenefitContribution::type_] end end end diff --git a/sig/finch_api/models/hris/benefit_create_params.rbs b/sig/finch_api/models/hris/benefit_create_params.rbs index 7b8ef2b1..0c331bb4 100644 --- a/sig/finch_api/models/hris/benefit_create_params.rbs +++ b/sig/finch_api/models/hris/benefit_create_params.rbs @@ -3,7 +3,7 @@ module FinchAPI module HRIS type benefit_create_params = { - company_contribution: FinchAPI::Models::HRIS::BenefitCreateParams::CompanyContribution?, + company_contribution: FinchAPI::HRIS::BenefitCreateParams::CompanyContribution?, description: String, frequency: FinchAPI::Models::HRIS::benefit_frequency?, type: FinchAPI::Models::HRIS::benefit_type? @@ -14,7 +14,7 @@ module FinchAPI extend FinchAPI::Internal::Type::RequestParameters::Converter include FinchAPI::Internal::Type::RequestParameters - attr_accessor company_contribution: FinchAPI::Models::HRIS::BenefitCreateParams::CompanyContribution? + attr_accessor company_contribution: FinchAPI::HRIS::BenefitCreateParams::CompanyContribution? attr_reader description: String? @@ -25,41 +25,37 @@ module FinchAPI attr_accessor type: FinchAPI::Models::HRIS::benefit_type? def initialize: ( - ?company_contribution: FinchAPI::Models::HRIS::BenefitCreateParams::CompanyContribution?, + ?company_contribution: FinchAPI::HRIS::BenefitCreateParams::CompanyContribution?, ?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 - type company_contribution = { - tiers: ::Array[FinchAPI::Models::HRIS::BenefitCreateParams::CompanyContribution::Tier], - type: FinchAPI::Models::HRIS::BenefitCreateParams::CompanyContribution::type_ + tiers: ::Array[FinchAPI::HRIS::BenefitCreateParams::CompanyContribution::Tier], + type: FinchAPI::HRIS::BenefitCreateParams::CompanyContribution::type_ } class CompanyContribution < FinchAPI::Internal::Type::BaseModel - attr_reader tiers: ::Array[FinchAPI::Models::HRIS::BenefitCreateParams::CompanyContribution::Tier]? + attr_reader tiers: ::Array[FinchAPI::HRIS::BenefitCreateParams::CompanyContribution::Tier]? def tiers=: ( - ::Array[FinchAPI::Models::HRIS::BenefitCreateParams::CompanyContribution::Tier] - ) -> ::Array[FinchAPI::Models::HRIS::BenefitCreateParams::CompanyContribution::Tier] + ::Array[FinchAPI::HRIS::BenefitCreateParams::CompanyContribution::Tier] + ) -> ::Array[FinchAPI::HRIS::BenefitCreateParams::CompanyContribution::Tier] - attr_reader type: FinchAPI::Models::HRIS::BenefitCreateParams::CompanyContribution::type_? + attr_reader type: FinchAPI::HRIS::BenefitCreateParams::CompanyContribution::type_? def type=: ( - FinchAPI::Models::HRIS::BenefitCreateParams::CompanyContribution::type_ - ) -> FinchAPI::Models::HRIS::BenefitCreateParams::CompanyContribution::type_ + FinchAPI::HRIS::BenefitCreateParams::CompanyContribution::type_ + ) -> FinchAPI::HRIS::BenefitCreateParams::CompanyContribution::type_ def initialize: ( - ?tiers: ::Array[FinchAPI::Models::HRIS::BenefitCreateParams::CompanyContribution::Tier], - ?type: FinchAPI::Models::HRIS::BenefitCreateParams::CompanyContribution::type_ + ?tiers: ::Array[FinchAPI::HRIS::BenefitCreateParams::CompanyContribution::Tier], + ?type: FinchAPI::HRIS::BenefitCreateParams::CompanyContribution::type_ ) -> void - def to_hash: -> FinchAPI::Models::HRIS::BenefitCreateParams::company_contribution - type tier = { match: Integer, threshold: Integer } class Tier < FinchAPI::Internal::Type::BaseModel @@ -72,8 +68,6 @@ module FinchAPI def threshold=: (Integer) -> Integer def initialize: (?match: Integer, ?threshold: Integer) -> void - - def to_hash: -> FinchAPI::Models::HRIS::BenefitCreateParams::CompanyContribution::tier end type type_ = :match @@ -83,7 +77,7 @@ module FinchAPI MATCH: :match - def self?.values: -> ::Array[FinchAPI::Models::HRIS::BenefitCreateParams::CompanyContribution::type_] + def self?.values: -> ::Array[FinchAPI::HRIS::BenefitCreateParams::CompanyContribution::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 09c51c11..4f743b17 100644 --- a/sig/finch_api/models/hris/benefit_features_and_operations.rbs +++ b/sig/finch_api/models/hris/benefit_features_and_operations.rbs @@ -3,39 +3,37 @@ module FinchAPI module HRIS type benefit_features_and_operations = { - supported_features: FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures, - supported_operations: FinchAPI::Models::HRIS::SupportPerBenefitType + supported_features: FinchAPI::HRIS::BenefitFeaturesAndOperations::SupportedFeatures, + supported_operations: FinchAPI::HRIS::SupportPerBenefitType } class BenefitFeaturesAndOperations < FinchAPI::Internal::Type::BaseModel - attr_reader supported_features: FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures? + attr_reader supported_features: FinchAPI::HRIS::BenefitFeaturesAndOperations::SupportedFeatures? def supported_features=: ( - FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures - ) -> FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures + FinchAPI::HRIS::BenefitFeaturesAndOperations::SupportedFeatures + ) -> FinchAPI::HRIS::BenefitFeaturesAndOperations::SupportedFeatures - attr_reader supported_operations: FinchAPI::Models::HRIS::SupportPerBenefitType? + attr_reader supported_operations: FinchAPI::HRIS::SupportPerBenefitType? def supported_operations=: ( - FinchAPI::Models::HRIS::SupportPerBenefitType - ) -> FinchAPI::Models::HRIS::SupportPerBenefitType + FinchAPI::HRIS::SupportPerBenefitType + ) -> FinchAPI::HRIS::SupportPerBenefitType def initialize: ( - ?supported_features: FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures, - ?supported_operations: FinchAPI::Models::HRIS::SupportPerBenefitType + ?supported_features: FinchAPI::HRIS::BenefitFeaturesAndOperations::SupportedFeatures, + ?supported_operations: FinchAPI::HRIS::SupportPerBenefitType ) -> void - def to_hash: -> FinchAPI::Models::HRIS::benefit_features_and_operations - type supported_features = { annual_maximum: bool?, catch_up: bool?, - company_contribution: ::Array[FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::company_contribution?]?, + company_contribution: ::Array[FinchAPI::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::company_contribution?]?, description: String?, - employee_deduction: ::Array[FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::employee_deduction?]?, + employee_deduction: ::Array[FinchAPI::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::employee_deduction?]?, frequencies: ::Array[FinchAPI::Models::HRIS::benefit_frequency?], - hsa_contribution_limit: ::Array[FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::hsa_contribution_limit?]? + hsa_contribution_limit: ::Array[FinchAPI::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::hsa_contribution_limit?]? } class SupportedFeatures < FinchAPI::Internal::Type::BaseModel @@ -43,11 +41,11 @@ module FinchAPI attr_accessor catch_up: bool? - attr_accessor company_contribution: ::Array[FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::company_contribution?]? + attr_accessor company_contribution: ::Array[FinchAPI::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::company_contribution?]? attr_accessor description: String? - attr_accessor employee_deduction: ::Array[FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::employee_deduction?]? + attr_accessor employee_deduction: ::Array[FinchAPI::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::employee_deduction?]? attr_reader frequencies: ::Array[FinchAPI::Models::HRIS::benefit_frequency?]? @@ -55,20 +53,18 @@ module FinchAPI ::Array[FinchAPI::Models::HRIS::benefit_frequency?] ) -> ::Array[FinchAPI::Models::HRIS::benefit_frequency?] - attr_accessor hsa_contribution_limit: ::Array[FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::hsa_contribution_limit?]? + attr_accessor hsa_contribution_limit: ::Array[FinchAPI::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::hsa_contribution_limit?]? def initialize: ( ?annual_maximum: bool?, ?catch_up: bool?, - ?company_contribution: ::Array[FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::company_contribution?]?, + ?company_contribution: ::Array[FinchAPI::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::company_contribution?]?, ?description: String?, - ?employee_deduction: ::Array[FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::employee_deduction?]?, + ?employee_deduction: ::Array[FinchAPI::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::employee_deduction?]?, ?frequencies: ::Array[FinchAPI::Models::HRIS::benefit_frequency?], - ?hsa_contribution_limit: ::Array[FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::hsa_contribution_limit?]? + ?hsa_contribution_limit: ::Array[FinchAPI::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::hsa_contribution_limit?]? ) -> void - def to_hash: -> FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::supported_features - type company_contribution = :fixed | :percent module CompanyContribution @@ -77,7 +73,7 @@ module FinchAPI FIXED: :fixed PERCENT: :percent - def self?.values: -> ::Array[FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::company_contribution] + def self?.values: -> ::Array[FinchAPI::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::company_contribution] end type employee_deduction = :fixed | :percent @@ -88,7 +84,7 @@ module FinchAPI FIXED: :fixed PERCENT: :percent - def self?.values: -> ::Array[FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::employee_deduction] + def self?.values: -> ::Array[FinchAPI::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::employee_deduction] end type hsa_contribution_limit = :individual | :family @@ -99,7 +95,7 @@ module FinchAPI INDIVIDUAL: :individual FAMILY: :family - def self?.values: -> ::Array[FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::hsa_contribution_limit] + def self?.values: -> ::Array[FinchAPI::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::hsa_contribution_limit] end end end diff --git a/sig/finch_api/models/hris/benefit_list_params.rbs b/sig/finch_api/models/hris/benefit_list_params.rbs index 271bcfdb..be84e750 100644 --- a/sig/finch_api/models/hris/benefit_list_params.rbs +++ b/sig/finch_api/models/hris/benefit_list_params.rbs @@ -9,8 +9,6 @@ module FinchAPI include FinchAPI::Internal::Type::RequestParameters def initialize: (?request_options: FinchAPI::request_opts) -> void - - def to_hash: -> FinchAPI::Models::HRIS::benefit_list_params end end 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 2046c620..7768aed8 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,8 +9,6 @@ module FinchAPI include FinchAPI::Internal::Type::RequestParameters def initialize: (?request_options: FinchAPI::request_opts) -> void - - def to_hash: -> FinchAPI::Models::HRIS::benefit_list_supported_benefits_params end end end diff --git a/sig/finch_api/models/hris/benefit_list_supported_benefits_response.rbs b/sig/finch_api/models/hris/benefit_list_supported_benefits_response.rbs index 4e77fb5b..26facf81 100644 --- a/sig/finch_api/models/hris/benefit_list_supported_benefits_response.rbs +++ b/sig/finch_api/models/hris/benefit_list_supported_benefits_response.rbs @@ -41,8 +41,6 @@ module FinchAPI ?hsa_contribution_limit: ::Array[FinchAPI::Models::HRIS::BenefitListSupportedBenefitsResponse::hsa_contribution_limit?]? ) -> void - def to_hash: -> FinchAPI::Models::HRIS::benefit_list_supported_benefits_response - type company_contribution = :fixed | :percent module CompanyContribution diff --git a/sig/finch_api/models/hris/benefit_retrieve_params.rbs b/sig/finch_api/models/hris/benefit_retrieve_params.rbs index dfa0110a..2f7d70ed 100644 --- a/sig/finch_api/models/hris/benefit_retrieve_params.rbs +++ b/sig/finch_api/models/hris/benefit_retrieve_params.rbs @@ -9,8 +9,6 @@ module FinchAPI include FinchAPI::Internal::Type::RequestParameters def initialize: (?request_options: FinchAPI::request_opts) -> void - - def to_hash: -> FinchAPI::Models::HRIS::benefit_retrieve_params end end end diff --git a/sig/finch_api/models/hris/benefit_update_params.rbs b/sig/finch_api/models/hris/benefit_update_params.rbs index 16132043..7e3a7993 100644 --- a/sig/finch_api/models/hris/benefit_update_params.rbs +++ b/sig/finch_api/models/hris/benefit_update_params.rbs @@ -16,8 +16,6 @@ module FinchAPI ?description: String, ?request_options: FinchAPI::request_opts ) -> void - - def to_hash: -> FinchAPI::Models::HRIS::benefit_update_params end end end diff --git a/sig/finch_api/models/hris/benefits/enrolled_individual_benefit_response.rbs b/sig/finch_api/models/hris/benefits/enrolled_individual_benefit_response.rbs index de9c01c7..5a27d6e3 100644 --- a/sig/finch_api/models/hris/benefits/enrolled_individual_benefit_response.rbs +++ b/sig/finch_api/models/hris/benefits/enrolled_individual_benefit_response.rbs @@ -8,8 +8,6 @@ module FinchAPI attr_accessor job_id: String def initialize: (job_id: String) -> void - - def to_hash: -> FinchAPI::Models::HRIS::Benefits::enrolled_individual_benefit_response 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 875552d1..66486183 100644 --- a/sig/finch_api/models/hris/benefits/individual_benefit.rbs +++ b/sig/finch_api/models/hris/benefits/individual_benefit.rbs @@ -6,17 +6,17 @@ module FinchAPI module Benefits type individual_benefit = { - body: FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body, + body: FinchAPI::HRIS::Benefits::IndividualBenefit::Body, code: Integer, individual_id: String } class IndividualBenefit < FinchAPI::Internal::Type::BaseModel - attr_reader body: FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body? + attr_reader body: FinchAPI::HRIS::Benefits::IndividualBenefit::Body? def body=: ( - FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body - ) -> FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body + FinchAPI::HRIS::Benefits::IndividualBenefit::Body + ) -> FinchAPI::HRIS::Benefits::IndividualBenefit::Body attr_reader code: Integer? @@ -27,20 +27,18 @@ module FinchAPI def individual_id=: (String) -> String def initialize: ( - ?body: FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body, + ?body: FinchAPI::HRIS::Benefits::IndividualBenefit::Body, ?code: Integer, ?individual_id: String ) -> void - def to_hash: -> FinchAPI::Models::HRIS::Benefits::individual_benefit - type body = { 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? + company_contribution: FinchAPI::HRIS::BenefitContribution?, + employee_deduction: FinchAPI::HRIS::BenefitContribution?, + hsa_contribution_limit: FinchAPI::HRIS::Benefits::IndividualBenefit::Body::hsa_contribution_limit? } class Body < FinchAPI::Internal::Type::BaseModel @@ -48,22 +46,20 @@ module FinchAPI attr_accessor catch_up: bool? - attr_accessor company_contribution: FinchAPI::Models::HRIS::BenefitContribution? + attr_accessor company_contribution: FinchAPI::HRIS::BenefitContribution? - attr_accessor employee_deduction: FinchAPI::Models::HRIS::BenefitContribution? + attr_accessor employee_deduction: FinchAPI::HRIS::BenefitContribution? - attr_accessor hsa_contribution_limit: FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::hsa_contribution_limit? + attr_accessor hsa_contribution_limit: FinchAPI::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? + ?company_contribution: FinchAPI::HRIS::BenefitContribution?, + ?employee_deduction: FinchAPI::HRIS::BenefitContribution?, + ?hsa_contribution_limit: FinchAPI::HRIS::Benefits::IndividualBenefit::Body::hsa_contribution_limit? ) -> void - def to_hash: -> FinchAPI::Models::HRIS::Benefits::IndividualBenefit::body - type hsa_contribution_limit = :individual | :family module HsaContributionLimit @@ -72,7 +68,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::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 d0840aaa..391f9f0e 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 @@ -4,7 +4,7 @@ module FinchAPI module Benefits type individual_enroll_many_params = { - individuals: ::Array[FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual] + individuals: ::Array[FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual] } & FinchAPI::Internal::Type::request_parameters @@ -12,59 +12,55 @@ module FinchAPI extend FinchAPI::Internal::Type::RequestParameters::Converter include FinchAPI::Internal::Type::RequestParameters - attr_reader individuals: ::Array[FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual]? + attr_reader individuals: ::Array[FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual]? def individuals=: ( - ::Array[FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual] - ) -> ::Array[FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual] + ::Array[FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual] + ) -> ::Array[FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual] def initialize: ( - ?individuals: ::Array[FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual], + ?individuals: ::Array[FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual], ?request_options: FinchAPI::request_opts ) -> void - def to_hash: -> FinchAPI::Models::HRIS::Benefits::individual_enroll_many_params - type individual = { - configuration: FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration, + configuration: FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration, individual_id: String } class Individual < FinchAPI::Internal::Type::BaseModel - attr_reader configuration: FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration? + attr_reader configuration: FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration? def configuration=: ( - FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration - ) -> FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration + FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration + ) -> FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration attr_reader individual_id: String? def individual_id=: (String) -> String def initialize: ( - ?configuration: FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration, + ?configuration: FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration, ?individual_id: String ) -> void - def to_hash: -> FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::individual - type configuration = { - annual_contribution_limit: FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::annual_contribution_limit, + annual_contribution_limit: FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::annual_contribution_limit, annual_maximum: Integer?, catch_up: bool, - company_contribution: FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution, + company_contribution: FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution, effective_date: Date, - employee_deduction: FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction + employee_deduction: FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction } class Configuration < FinchAPI::Internal::Type::BaseModel - attr_reader annual_contribution_limit: FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::annual_contribution_limit? + attr_reader annual_contribution_limit: FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::annual_contribution_limit? def annual_contribution_limit=: ( - FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::annual_contribution_limit - ) -> FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::annual_contribution_limit + FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::annual_contribution_limit + ) -> FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::annual_contribution_limit attr_accessor annual_maximum: Integer? @@ -72,33 +68,31 @@ module FinchAPI def catch_up=: (bool) -> bool - attr_reader company_contribution: FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution? + attr_reader company_contribution: FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution? def company_contribution=: ( - FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution - ) -> FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution + FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution + ) -> FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution attr_reader effective_date: Date? def effective_date=: (Date) -> Date - attr_reader employee_deduction: FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction? + attr_reader employee_deduction: FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction? def employee_deduction=: ( - FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction - ) -> FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction + FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction + ) -> FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction def initialize: ( - ?annual_contribution_limit: FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::annual_contribution_limit, + ?annual_contribution_limit: FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::annual_contribution_limit, ?annual_maximum: Integer?, ?catch_up: bool, - ?company_contribution: FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution, + ?company_contribution: FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution, ?effective_date: Date, - ?employee_deduction: FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction + ?employee_deduction: FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction ) -> void - def to_hash: -> FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::configuration - type annual_contribution_limit = :individual | :family module AnnualContributionLimit @@ -107,13 +101,13 @@ 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::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::annual_contribution_limit] end type company_contribution = { amount: Integer, - type: FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution::type_ + type: FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution::type_ } class CompanyContribution < FinchAPI::Internal::Type::BaseModel @@ -121,19 +115,17 @@ module FinchAPI def amount=: (Integer) -> Integer - attr_reader type: FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution::type_? + attr_reader type: FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution::type_? def type=: ( - FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution::type_ - ) -> FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution::type_ + FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution::type_ + ) -> FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution::type_ def initialize: ( ?amount: Integer, - ?type: FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution::type_ + ?type: FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution::type_ ) -> void - def to_hash: -> FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::company_contribution - type type_ = :fixed | :percent module Type @@ -142,14 +134,14 @@ module FinchAPI FIXED: :fixed PERCENT: :percent - def self?.values: -> ::Array[FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution::type_] + def self?.values: -> ::Array[FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution::type_] end end type employee_deduction = { amount: Integer, - type: FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction::type_ + type: FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction::type_ } class EmployeeDeduction < FinchAPI::Internal::Type::BaseModel @@ -157,19 +149,17 @@ module FinchAPI def amount=: (Integer) -> Integer - attr_reader type: FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction::type_? + attr_reader type: FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction::type_? def type=: ( - FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction::type_ - ) -> FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction::type_ + FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction::type_ + ) -> FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction::type_ def initialize: ( ?amount: Integer, - ?type: FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction::type_ + ?type: FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction::type_ ) -> void - def to_hash: -> FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::employee_deduction - type type_ = :fixed | :percent module Type @@ -178,7 +168,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::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction::type_] end end end 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 070780e0..2d9bf817 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,8 +10,6 @@ module FinchAPI include FinchAPI::Internal::Type::RequestParameters def initialize: (?request_options: FinchAPI::request_opts) -> void - - def to_hash: -> FinchAPI::Models::HRIS::Benefits::individual_enrolled_ids_params end end 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 ee785e4b..c61f88a5 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 @@ -14,8 +14,6 @@ module FinchAPI benefit_id: String, individual_ids: ::Array[String] ) -> void - - def to_hash: -> FinchAPI::Models::HRIS::Benefits::individual_enrolled_ids_response end end 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 5ad243f0..68f41a8c 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 @@ -18,8 +18,6 @@ module FinchAPI ?individual_ids: String, ?request_options: FinchAPI::request_opts ) -> void - - def to_hash: -> FinchAPI::Models::HRIS::Benefits::individual_retrieve_many_benefits_params end end 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 9e5cd958..5ba6ab1c 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 @@ -18,8 +18,6 @@ module FinchAPI ?individual_ids: ::Array[String], ?request_options: FinchAPI::request_opts ) -> void - - def to_hash: -> FinchAPI::Models::HRIS::Benefits::individual_unenroll_many_params end end end diff --git a/sig/finch_api/models/hris/benefits/unenrolled_individual_benefit_response.rbs b/sig/finch_api/models/hris/benefits/unenrolled_individual_benefit_response.rbs index 52bee538..bc20b6e6 100644 --- a/sig/finch_api/models/hris/benefits/unenrolled_individual_benefit_response.rbs +++ b/sig/finch_api/models/hris/benefits/unenrolled_individual_benefit_response.rbs @@ -8,8 +8,6 @@ module FinchAPI attr_accessor job_id: String def initialize: (job_id: String) -> void - - def to_hash: -> FinchAPI::Models::HRIS::Benefits::unenrolled_individual_benefit_response end end end diff --git a/sig/finch_api/models/hris/benefits_support.rbs b/sig/finch_api/models/hris/benefits_support.rbs index 9aa48257..e3cc0d95 100644 --- a/sig/finch_api/models/hris/benefits_support.rbs +++ b/sig/finch_api/models/hris/benefits_support.rbs @@ -3,61 +3,59 @@ module FinchAPI module HRIS type benefits_support = { - 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::HRIS::BenefitFeaturesAndOperations?, + custom_post_tax: FinchAPI::HRIS::BenefitFeaturesAndOperations?, + custom_pre_tax: FinchAPI::HRIS::BenefitFeaturesAndOperations?, + fsa_dependent_care: FinchAPI::HRIS::BenefitFeaturesAndOperations?, + fsa_medical: FinchAPI::HRIS::BenefitFeaturesAndOperations?, + hsa_post: FinchAPI::HRIS::BenefitFeaturesAndOperations?, + hsa_pre: FinchAPI::HRIS::BenefitFeaturesAndOperations?, + :s125_dental => FinchAPI::HRIS::BenefitFeaturesAndOperations?, + :s125_medical => FinchAPI::HRIS::BenefitFeaturesAndOperations?, + :s125_vision => FinchAPI::HRIS::BenefitFeaturesAndOperations?, + simple: FinchAPI::HRIS::BenefitFeaturesAndOperations?, + simple_ira: FinchAPI::HRIS::BenefitFeaturesAndOperations? } class BenefitsSupport < FinchAPI::Internal::Type::BaseModel - attr_accessor commuter: FinchAPI::Models::HRIS::BenefitFeaturesAndOperations? + attr_accessor commuter: FinchAPI::HRIS::BenefitFeaturesAndOperations? - attr_accessor custom_post_tax: FinchAPI::Models::HRIS::BenefitFeaturesAndOperations? + attr_accessor custom_post_tax: FinchAPI::HRIS::BenefitFeaturesAndOperations? - attr_accessor custom_pre_tax: FinchAPI::Models::HRIS::BenefitFeaturesAndOperations? + attr_accessor custom_pre_tax: FinchAPI::HRIS::BenefitFeaturesAndOperations? - attr_accessor fsa_dependent_care: FinchAPI::Models::HRIS::BenefitFeaturesAndOperations? + attr_accessor fsa_dependent_care: FinchAPI::HRIS::BenefitFeaturesAndOperations? - attr_accessor fsa_medical: FinchAPI::Models::HRIS::BenefitFeaturesAndOperations? + attr_accessor fsa_medical: FinchAPI::HRIS::BenefitFeaturesAndOperations? - attr_accessor hsa_post: FinchAPI::Models::HRIS::BenefitFeaturesAndOperations? + attr_accessor hsa_post: FinchAPI::HRIS::BenefitFeaturesAndOperations? - attr_accessor hsa_pre: FinchAPI::Models::HRIS::BenefitFeaturesAndOperations? + attr_accessor hsa_pre: FinchAPI::HRIS::BenefitFeaturesAndOperations? - attr_accessor s125_dental: FinchAPI::Models::HRIS::BenefitFeaturesAndOperations? + attr_accessor s125_dental: FinchAPI::HRIS::BenefitFeaturesAndOperations? - attr_accessor s125_medical: FinchAPI::Models::HRIS::BenefitFeaturesAndOperations? + attr_accessor s125_medical: FinchAPI::HRIS::BenefitFeaturesAndOperations? - attr_accessor s125_vision: FinchAPI::Models::HRIS::BenefitFeaturesAndOperations? + attr_accessor s125_vision: FinchAPI::HRIS::BenefitFeaturesAndOperations? - attr_accessor simple: FinchAPI::Models::HRIS::BenefitFeaturesAndOperations? + attr_accessor simple: FinchAPI::HRIS::BenefitFeaturesAndOperations? - attr_accessor simple_ira: FinchAPI::Models::HRIS::BenefitFeaturesAndOperations? + attr_accessor simple_ira: FinchAPI::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? + ?commuter: FinchAPI::HRIS::BenefitFeaturesAndOperations?, + ?custom_post_tax: FinchAPI::HRIS::BenefitFeaturesAndOperations?, + ?custom_pre_tax: FinchAPI::HRIS::BenefitFeaturesAndOperations?, + ?fsa_dependent_care: FinchAPI::HRIS::BenefitFeaturesAndOperations?, + ?fsa_medical: FinchAPI::HRIS::BenefitFeaturesAndOperations?, + ?hsa_post: FinchAPI::HRIS::BenefitFeaturesAndOperations?, + ?hsa_pre: FinchAPI::HRIS::BenefitFeaturesAndOperations?, + ?s125_dental: FinchAPI::HRIS::BenefitFeaturesAndOperations?, + ?s125_medical: FinchAPI::HRIS::BenefitFeaturesAndOperations?, + ?s125_vision: FinchAPI::HRIS::BenefitFeaturesAndOperations?, + ?simple: FinchAPI::HRIS::BenefitFeaturesAndOperations?, + ?simple_ira: FinchAPI::HRIS::BenefitFeaturesAndOperations? ) -> void - - def to_hash: -> FinchAPI::Models::HRIS::benefits_support end end end diff --git a/sig/finch_api/models/hris/company.rbs b/sig/finch_api/models/hris/company.rbs index ec3cc7e9..cb15090b 100644 --- a/sig/finch_api/models/hris/company.rbs +++ b/sig/finch_api/models/hris/company.rbs @@ -4,12 +4,12 @@ module FinchAPI type hris_company = { id: String, - accounts: ::Array[FinchAPI::Models::HRIS::HRISCompany::Account]?, - departments: ::Array[FinchAPI::Models::HRIS::HRISCompany::Department?]?, + accounts: ::Array[FinchAPI::HRIS::HRISCompany::Account]?, + departments: ::Array[FinchAPI::HRIS::HRISCompany::Department?]?, ein: String?, - entity: FinchAPI::Models::HRIS::HRISCompany::Entity?, + entity: FinchAPI::HRIS::HRISCompany::Entity?, legal_name: String?, - locations: ::Array[FinchAPI::Models::Location?]?, + locations: ::Array[FinchAPI::Location?]?, primary_email: String?, primary_phone_number: String? } @@ -17,17 +17,17 @@ module FinchAPI class HRISCompany < FinchAPI::Internal::Type::BaseModel attr_accessor id: String - attr_accessor accounts: ::Array[FinchAPI::Models::HRIS::HRISCompany::Account]? + attr_accessor accounts: ::Array[FinchAPI::HRIS::HRISCompany::Account]? - attr_accessor departments: ::Array[FinchAPI::Models::HRIS::HRISCompany::Department?]? + attr_accessor departments: ::Array[FinchAPI::HRIS::HRISCompany::Department?]? attr_accessor ein: String? - attr_accessor entity: FinchAPI::Models::HRIS::HRISCompany::Entity? + attr_accessor entity: FinchAPI::HRIS::HRISCompany::Entity? attr_accessor legal_name: String? - attr_accessor locations: ::Array[FinchAPI::Models::Location?]? + attr_accessor locations: ::Array[FinchAPI::Location?]? attr_accessor primary_email: String? @@ -35,23 +35,21 @@ module FinchAPI def initialize: ( id: String, - accounts: ::Array[FinchAPI::Models::HRIS::HRISCompany::Account]?, - departments: ::Array[FinchAPI::Models::HRIS::HRISCompany::Department?]?, + accounts: ::Array[FinchAPI::HRIS::HRISCompany::Account]?, + departments: ::Array[FinchAPI::HRIS::HRISCompany::Department?]?, ein: String?, - entity: FinchAPI::Models::HRIS::HRISCompany::Entity?, + entity: FinchAPI::HRIS::HRISCompany::Entity?, legal_name: String?, - locations: ::Array[FinchAPI::Models::Location?]?, + locations: ::Array[FinchAPI::Location?]?, primary_email: String?, primary_phone_number: String? ) -> void - def to_hash: -> FinchAPI::Models::HRIS::hris_company - type account = { account_name: String?, account_number: String?, - account_type: FinchAPI::Models::HRIS::HRISCompany::Account::account_type?, + account_type: FinchAPI::HRIS::HRISCompany::Account::account_type?, institution_name: String?, routing_number: String? } @@ -61,7 +59,7 @@ module FinchAPI attr_accessor account_number: String? - attr_accessor account_type: FinchAPI::Models::HRIS::HRISCompany::Account::account_type? + attr_accessor account_type: FinchAPI::HRIS::HRISCompany::Account::account_type? attr_accessor institution_name: String? @@ -70,13 +68,11 @@ module FinchAPI def initialize: ( account_name: String?, account_number: String?, - account_type: FinchAPI::Models::HRIS::HRISCompany::Account::account_type?, + account_type: FinchAPI::HRIS::HRISCompany::Account::account_type?, institution_name: String?, routing_number: String? ) -> void - def to_hash: -> FinchAPI::Models::HRIS::HRISCompany::account - type account_type = :checking | :savings module AccountType @@ -85,57 +81,51 @@ module FinchAPI CHECKING: :checking SAVINGS: :savings - def self?.values: -> ::Array[FinchAPI::Models::HRIS::HRISCompany::Account::account_type] + def self?.values: -> ::Array[FinchAPI::HRIS::HRISCompany::Account::account_type] end end type department = { name: String?, - parent: FinchAPI::Models::HRIS::HRISCompany::Department::Parent? + parent: FinchAPI::HRIS::HRISCompany::Department::Parent? } class Department < FinchAPI::Internal::Type::BaseModel attr_accessor name: String? - attr_accessor parent: FinchAPI::Models::HRIS::HRISCompany::Department::Parent? + attr_accessor parent: FinchAPI::HRIS::HRISCompany::Department::Parent? def initialize: ( name: String?, - parent: FinchAPI::Models::HRIS::HRISCompany::Department::Parent? + parent: FinchAPI::HRIS::HRISCompany::Department::Parent? ) -> void - def to_hash: -> FinchAPI::Models::HRIS::HRISCompany::department - type parent = { name: String? } class Parent < FinchAPI::Internal::Type::BaseModel attr_accessor name: String? def initialize: (name: String?) -> void - - def to_hash: -> FinchAPI::Models::HRIS::HRISCompany::Department::parent end end type entity = { - subtype: FinchAPI::Models::HRIS::HRISCompany::Entity::subtype?, - type: FinchAPI::Models::HRIS::HRISCompany::Entity::type_? + subtype: FinchAPI::HRIS::HRISCompany::Entity::subtype?, + type: FinchAPI::HRIS::HRISCompany::Entity::type_? } class Entity < FinchAPI::Internal::Type::BaseModel - attr_accessor subtype: FinchAPI::Models::HRIS::HRISCompany::Entity::subtype? + attr_accessor subtype: FinchAPI::HRIS::HRISCompany::Entity::subtype? - attr_accessor type: FinchAPI::Models::HRIS::HRISCompany::Entity::type_? + attr_accessor type: FinchAPI::HRIS::HRISCompany::Entity::type_? def initialize: ( - subtype: FinchAPI::Models::HRIS::HRISCompany::Entity::subtype?, - type: FinchAPI::Models::HRIS::HRISCompany::Entity::type_? + subtype: FinchAPI::HRIS::HRISCompany::Entity::subtype?, + type: FinchAPI::HRIS::HRISCompany::Entity::type_? ) -> void - def to_hash: -> FinchAPI::Models::HRIS::HRISCompany::entity - type subtype = :s_corporation | :c_corporation | :b_corporation module Subtype @@ -145,7 +135,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::HRIS::HRISCompany::Entity::subtype] end type type_ = @@ -168,7 +158,7 @@ module FinchAPI PARTNERSHIP: :partnership COOPERATIVE: :cooperative - def self?.values: -> ::Array[FinchAPI::Models::HRIS::HRISCompany::Entity::type_] + def self?.values: -> ::Array[FinchAPI::HRIS::HRISCompany::Entity::type_] end end end diff --git a/sig/finch_api/models/hris/company/pay_statement_item/rule_create_params.rbs b/sig/finch_api/models/hris/company/pay_statement_item/rule_create_params.rbs index b025729e..ac3a3aad 100644 --- a/sig/finch_api/models/hris/company/pay_statement_item/rule_create_params.rbs +++ b/sig/finch_api/models/hris/company/pay_statement_item/rule_create_params.rbs @@ -5,8 +5,8 @@ module FinchAPI module PayStatementItem type rule_create_params = { - attributes: FinchAPI::Models::HRIS::Company::PayStatementItem::RuleCreateParams::Attributes, - conditions: ::Array[FinchAPI::Models::HRIS::Company::PayStatementItem::RuleCreateParams::Condition], + attributes: FinchAPI::HRIS::Company::PayStatementItem::RuleCreateParams::Attributes, + conditions: ::Array[FinchAPI::HRIS::Company::PayStatementItem::RuleCreateParams::Condition], effective_end_date: String?, effective_start_date: String?, entity_type: FinchAPI::Models::HRIS::Company::PayStatementItem::RuleCreateParams::entity_type @@ -17,17 +17,17 @@ module FinchAPI extend FinchAPI::Internal::Type::RequestParameters::Converter include FinchAPI::Internal::Type::RequestParameters - attr_reader attributes: FinchAPI::Models::HRIS::Company::PayStatementItem::RuleCreateParams::Attributes? + attr_reader attributes: FinchAPI::HRIS::Company::PayStatementItem::RuleCreateParams::Attributes? def attributes=: ( - FinchAPI::Models::HRIS::Company::PayStatementItem::RuleCreateParams::Attributes - ) -> FinchAPI::Models::HRIS::Company::PayStatementItem::RuleCreateParams::Attributes + FinchAPI::HRIS::Company::PayStatementItem::RuleCreateParams::Attributes + ) -> FinchAPI::HRIS::Company::PayStatementItem::RuleCreateParams::Attributes - attr_reader conditions: ::Array[FinchAPI::Models::HRIS::Company::PayStatementItem::RuleCreateParams::Condition]? + attr_reader conditions: ::Array[FinchAPI::HRIS::Company::PayStatementItem::RuleCreateParams::Condition]? def conditions=: ( - ::Array[FinchAPI::Models::HRIS::Company::PayStatementItem::RuleCreateParams::Condition] - ) -> ::Array[FinchAPI::Models::HRIS::Company::PayStatementItem::RuleCreateParams::Condition] + ::Array[FinchAPI::HRIS::Company::PayStatementItem::RuleCreateParams::Condition] + ) -> ::Array[FinchAPI::HRIS::Company::PayStatementItem::RuleCreateParams::Condition] attr_accessor effective_end_date: String? @@ -40,16 +40,14 @@ module FinchAPI ) -> FinchAPI::Models::HRIS::Company::PayStatementItem::RuleCreateParams::entity_type def initialize: ( - ?attributes: FinchAPI::Models::HRIS::Company::PayStatementItem::RuleCreateParams::Attributes, - ?conditions: ::Array[FinchAPI::Models::HRIS::Company::PayStatementItem::RuleCreateParams::Condition], + ?attributes: FinchAPI::HRIS::Company::PayStatementItem::RuleCreateParams::Attributes, + ?conditions: ::Array[FinchAPI::HRIS::Company::PayStatementItem::RuleCreateParams::Condition], ?effective_end_date: String?, ?effective_start_date: String?, ?entity_type: FinchAPI::Models::HRIS::Company::PayStatementItem::RuleCreateParams::entity_type, ?request_options: FinchAPI::request_opts ) -> void - def to_hash: -> FinchAPI::Models::HRIS::Company::PayStatementItem::rule_create_params - type attributes = { metadata: ::Hash[Symbol, top] } class Attributes < FinchAPI::Internal::Type::BaseModel @@ -58,14 +56,12 @@ module FinchAPI def metadata=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top] def initialize: (?metadata: ::Hash[Symbol, top]) -> void - - def to_hash: -> FinchAPI::Models::HRIS::Company::PayStatementItem::RuleCreateParams::attributes end type condition = { field: String, - operator: FinchAPI::Models::HRIS::Company::PayStatementItem::RuleCreateParams::Condition::operator, + operator: FinchAPI::HRIS::Company::PayStatementItem::RuleCreateParams::Condition::operator, value: String } @@ -74,11 +70,11 @@ module FinchAPI def field=: (String) -> String - attr_reader operator: FinchAPI::Models::HRIS::Company::PayStatementItem::RuleCreateParams::Condition::operator? + attr_reader operator: FinchAPI::HRIS::Company::PayStatementItem::RuleCreateParams::Condition::operator? def operator=: ( - FinchAPI::Models::HRIS::Company::PayStatementItem::RuleCreateParams::Condition::operator - ) -> FinchAPI::Models::HRIS::Company::PayStatementItem::RuleCreateParams::Condition::operator + FinchAPI::HRIS::Company::PayStatementItem::RuleCreateParams::Condition::operator + ) -> FinchAPI::HRIS::Company::PayStatementItem::RuleCreateParams::Condition::operator attr_reader value: String? @@ -86,12 +82,10 @@ module FinchAPI def initialize: ( ?field: String, - ?operator: FinchAPI::Models::HRIS::Company::PayStatementItem::RuleCreateParams::Condition::operator, + ?operator: FinchAPI::HRIS::Company::PayStatementItem::RuleCreateParams::Condition::operator, ?value: String ) -> void - def to_hash: -> FinchAPI::Models::HRIS::Company::PayStatementItem::RuleCreateParams::condition - type operator = :equals module Operator @@ -99,7 +93,7 @@ module FinchAPI EQUALS: :equals - def self?.values: -> ::Array[FinchAPI::Models::HRIS::Company::PayStatementItem::RuleCreateParams::Condition::operator] + def self?.values: -> ::Array[FinchAPI::HRIS::Company::PayStatementItem::RuleCreateParams::Condition::operator] end end diff --git a/sig/finch_api/models/hris/company/pay_statement_item/rule_create_response.rbs b/sig/finch_api/models/hris/company/pay_statement_item/rule_create_response.rbs index a0922d82..ecec8fad 100644 --- a/sig/finch_api/models/hris/company/pay_statement_item/rule_create_response.rbs +++ b/sig/finch_api/models/hris/company/pay_statement_item/rule_create_response.rbs @@ -67,8 +67,6 @@ module FinchAPI ?updated_at: Time ) -> void - def to_hash: -> FinchAPI::Models::HRIS::Company::PayStatementItem::rule_create_response - type attributes = { metadata: ::Hash[Symbol, top] } class Attributes < FinchAPI::Internal::Type::BaseModel @@ -77,8 +75,6 @@ module FinchAPI def metadata=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top] def initialize: (?metadata: ::Hash[Symbol, top]) -> void - - def to_hash: -> FinchAPI::Models::HRIS::Company::PayStatementItem::RuleCreateResponse::attributes end type condition = @@ -109,8 +105,6 @@ module FinchAPI ?value: String ) -> void - def to_hash: -> FinchAPI::Models::HRIS::Company::PayStatementItem::RuleCreateResponse::condition - type operator = :equals module Operator diff --git a/sig/finch_api/models/hris/company/pay_statement_item/rule_delete_params.rbs b/sig/finch_api/models/hris/company/pay_statement_item/rule_delete_params.rbs index 105d66d0..8a907043 100644 --- a/sig/finch_api/models/hris/company/pay_statement_item/rule_delete_params.rbs +++ b/sig/finch_api/models/hris/company/pay_statement_item/rule_delete_params.rbs @@ -11,8 +11,6 @@ module FinchAPI include FinchAPI::Internal::Type::RequestParameters def initialize: (?request_options: FinchAPI::request_opts) -> void - - def to_hash: -> FinchAPI::Models::HRIS::Company::PayStatementItem::rule_delete_params end end end diff --git a/sig/finch_api/models/hris/company/pay_statement_item/rule_delete_response.rbs b/sig/finch_api/models/hris/company/pay_statement_item/rule_delete_response.rbs index 842079b4..274e01f3 100644 --- a/sig/finch_api/models/hris/company/pay_statement_item/rule_delete_response.rbs +++ b/sig/finch_api/models/hris/company/pay_statement_item/rule_delete_response.rbs @@ -73,8 +73,6 @@ module FinchAPI ?updated_at: Time ) -> void - def to_hash: -> FinchAPI::Models::HRIS::Company::PayStatementItem::rule_delete_response - type attributes = { metadata: ::Hash[Symbol, top] } class Attributes < FinchAPI::Internal::Type::BaseModel @@ -83,8 +81,6 @@ module FinchAPI def metadata=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top] def initialize: (?metadata: ::Hash[Symbol, top]) -> void - - def to_hash: -> FinchAPI::Models::HRIS::Company::PayStatementItem::RuleDeleteResponse::attributes end type condition = @@ -115,8 +111,6 @@ module FinchAPI ?value: String ) -> void - def to_hash: -> FinchAPI::Models::HRIS::Company::PayStatementItem::RuleDeleteResponse::condition - type operator = :equals module Operator diff --git a/sig/finch_api/models/hris/company/pay_statement_item/rule_list_params.rbs b/sig/finch_api/models/hris/company/pay_statement_item/rule_list_params.rbs index aa17bf9c..06587199 100644 --- a/sig/finch_api/models/hris/company/pay_statement_item/rule_list_params.rbs +++ b/sig/finch_api/models/hris/company/pay_statement_item/rule_list_params.rbs @@ -11,8 +11,6 @@ module FinchAPI include FinchAPI::Internal::Type::RequestParameters def initialize: (?request_options: FinchAPI::request_opts) -> void - - def to_hash: -> FinchAPI::Models::HRIS::Company::PayStatementItem::rule_list_params end end end diff --git a/sig/finch_api/models/hris/company/pay_statement_item/rule_list_response.rbs b/sig/finch_api/models/hris/company/pay_statement_item/rule_list_response.rbs index 453140f7..5ea65c83 100644 --- a/sig/finch_api/models/hris/company/pay_statement_item/rule_list_response.rbs +++ b/sig/finch_api/models/hris/company/pay_statement_item/rule_list_response.rbs @@ -67,8 +67,6 @@ module FinchAPI ?updated_at: Time ) -> void - def to_hash: -> FinchAPI::Models::HRIS::Company::PayStatementItem::rule_list_response - type attributes = { metadata: ::Hash[Symbol, top] } class Attributes < FinchAPI::Internal::Type::BaseModel @@ -77,8 +75,6 @@ module FinchAPI def metadata=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top] def initialize: (?metadata: ::Hash[Symbol, top]) -> void - - def to_hash: -> FinchAPI::Models::HRIS::Company::PayStatementItem::RuleListResponse::attributes end type condition = @@ -109,8 +105,6 @@ module FinchAPI ?value: String ) -> void - def to_hash: -> FinchAPI::Models::HRIS::Company::PayStatementItem::RuleListResponse::condition - type operator = :equals module Operator diff --git a/sig/finch_api/models/hris/company/pay_statement_item/rule_update_params.rbs b/sig/finch_api/models/hris/company/pay_statement_item/rule_update_params.rbs index 9398f059..9131569d 100644 --- a/sig/finch_api/models/hris/company/pay_statement_item/rule_update_params.rbs +++ b/sig/finch_api/models/hris/company/pay_statement_item/rule_update_params.rbs @@ -19,8 +19,6 @@ module FinchAPI ?optional_property: top, ?request_options: FinchAPI::request_opts ) -> void - - def to_hash: -> FinchAPI::Models::HRIS::Company::PayStatementItem::rule_update_params end end end diff --git a/sig/finch_api/models/hris/company/pay_statement_item/rule_update_response.rbs b/sig/finch_api/models/hris/company/pay_statement_item/rule_update_response.rbs index c2a65bfa..02affb29 100644 --- a/sig/finch_api/models/hris/company/pay_statement_item/rule_update_response.rbs +++ b/sig/finch_api/models/hris/company/pay_statement_item/rule_update_response.rbs @@ -67,8 +67,6 @@ module FinchAPI ?updated_at: Time ) -> void - def to_hash: -> FinchAPI::Models::HRIS::Company::PayStatementItem::rule_update_response - type attributes = { metadata: ::Hash[Symbol, top] } class Attributes < FinchAPI::Internal::Type::BaseModel @@ -77,8 +75,6 @@ module FinchAPI def metadata=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top] def initialize: (?metadata: ::Hash[Symbol, top]) -> void - - def to_hash: -> FinchAPI::Models::HRIS::Company::PayStatementItem::RuleUpdateResponse::attributes end type condition = @@ -109,8 +105,6 @@ module FinchAPI ?value: String ) -> void - def to_hash: -> FinchAPI::Models::HRIS::Company::PayStatementItem::RuleUpdateResponse::condition - type operator = :equals module Operator diff --git a/sig/finch_api/models/hris/company/pay_statement_item_list_params.rbs b/sig/finch_api/models/hris/company/pay_statement_item_list_params.rbs index d558e1a9..90b1e908 100644 --- a/sig/finch_api/models/hris/company/pay_statement_item_list_params.rbs +++ b/sig/finch_api/models/hris/company/pay_statement_item_list_params.rbs @@ -4,7 +4,7 @@ module FinchAPI module Company type pay_statement_item_list_params = { - categories: ::Array[FinchAPI::Models::HRIS::Company::PayStatementItemListParams::category], + categories: ::Array[FinchAPI::HRIS::Company::PayStatementItemListParams::category], end_date: Date, name: String, start_date: Date, @@ -16,11 +16,11 @@ module FinchAPI extend FinchAPI::Internal::Type::RequestParameters::Converter include FinchAPI::Internal::Type::RequestParameters - attr_reader categories: ::Array[FinchAPI::Models::HRIS::Company::PayStatementItemListParams::category]? + attr_reader categories: ::Array[FinchAPI::HRIS::Company::PayStatementItemListParams::category]? def categories=: ( - ::Array[FinchAPI::Models::HRIS::Company::PayStatementItemListParams::category] - ) -> ::Array[FinchAPI::Models::HRIS::Company::PayStatementItemListParams::category] + ::Array[FinchAPI::HRIS::Company::PayStatementItemListParams::category] + ) -> ::Array[FinchAPI::HRIS::Company::PayStatementItemListParams::category] attr_reader end_date: Date? @@ -39,7 +39,7 @@ module FinchAPI def type=: (String) -> String def initialize: ( - ?categories: ::Array[FinchAPI::Models::HRIS::Company::PayStatementItemListParams::category], + ?categories: ::Array[FinchAPI::HRIS::Company::PayStatementItemListParams::category], ?end_date: Date, ?name: String, ?start_date: Date, @@ -47,8 +47,6 @@ module FinchAPI ?request_options: FinchAPI::request_opts ) -> void - def to_hash: -> FinchAPI::Models::HRIS::Company::pay_statement_item_list_params - type category = :earnings | :taxes | :employee_deductions | :employer_contributions @@ -60,7 +58,7 @@ module FinchAPI EMPLOYEE_DEDUCTIONS: :employee_deductions EMPLOYER_CONTRIBUTIONS: :employer_contributions - def self?.values: -> ::Array[FinchAPI::Models::HRIS::Company::PayStatementItemListParams::category] + def self?.values: -> ::Array[FinchAPI::HRIS::Company::PayStatementItemListParams::category] end end end diff --git a/sig/finch_api/models/hris/company/pay_statement_item_list_response.rbs b/sig/finch_api/models/hris/company/pay_statement_item_list_response.rbs index 44eb6bc6..75713a6d 100644 --- a/sig/finch_api/models/hris/company/pay_statement_item_list_response.rbs +++ b/sig/finch_api/models/hris/company/pay_statement_item_list_response.rbs @@ -32,8 +32,6 @@ module FinchAPI ?name: String ) -> void - def to_hash: -> FinchAPI::Models::HRIS::Company::pay_statement_item_list_response - type attributes = { employer: bool?, @@ -57,8 +55,6 @@ module FinchAPI ?pre_tax: bool?, ?type: String? ) -> void - - def to_hash: -> FinchAPI::Models::HRIS::Company::PayStatementItemListResponse::attributes end type category = diff --git a/sig/finch_api/models/hris/company_benefit.rbs b/sig/finch_api/models/hris/company_benefit.rbs index 6cacbce7..4d4b3086 100644 --- a/sig/finch_api/models/hris/company_benefit.rbs +++ b/sig/finch_api/models/hris/company_benefit.rbs @@ -4,7 +4,7 @@ module FinchAPI type company_benefit = { benefit_id: String, - company_contribution: FinchAPI::Models::HRIS::CompanyBenefit::CompanyContribution?, + company_contribution: FinchAPI::HRIS::CompanyBenefit::CompanyContribution?, description: String?, frequency: FinchAPI::Models::HRIS::benefit_frequency?, type: FinchAPI::Models::HRIS::benefit_type? @@ -13,7 +13,7 @@ module FinchAPI class CompanyBenefit < FinchAPI::Internal::Type::BaseModel attr_accessor benefit_id: String - attr_accessor company_contribution: FinchAPI::Models::HRIS::CompanyBenefit::CompanyContribution? + attr_accessor company_contribution: FinchAPI::HRIS::CompanyBenefit::CompanyContribution? attr_accessor description: String? @@ -23,40 +23,36 @@ module FinchAPI def initialize: ( benefit_id: String, - company_contribution: FinchAPI::Models::HRIS::CompanyBenefit::CompanyContribution?, + company_contribution: FinchAPI::HRIS::CompanyBenefit::CompanyContribution?, description: String?, frequency: FinchAPI::Models::HRIS::benefit_frequency?, type: FinchAPI::Models::HRIS::benefit_type? ) -> void - def to_hash: -> FinchAPI::Models::HRIS::company_benefit - type company_contribution = { - tiers: ::Array[FinchAPI::Models::HRIS::CompanyBenefit::CompanyContribution::Tier], - type: FinchAPI::Models::HRIS::CompanyBenefit::CompanyContribution::type_ + tiers: ::Array[FinchAPI::HRIS::CompanyBenefit::CompanyContribution::Tier], + type: FinchAPI::HRIS::CompanyBenefit::CompanyContribution::type_ } class CompanyContribution < FinchAPI::Internal::Type::BaseModel - attr_reader tiers: ::Array[FinchAPI::Models::HRIS::CompanyBenefit::CompanyContribution::Tier]? + attr_reader tiers: ::Array[FinchAPI::HRIS::CompanyBenefit::CompanyContribution::Tier]? def tiers=: ( - ::Array[FinchAPI::Models::HRIS::CompanyBenefit::CompanyContribution::Tier] - ) -> ::Array[FinchAPI::Models::HRIS::CompanyBenefit::CompanyContribution::Tier] + ::Array[FinchAPI::HRIS::CompanyBenefit::CompanyContribution::Tier] + ) -> ::Array[FinchAPI::HRIS::CompanyBenefit::CompanyContribution::Tier] - attr_reader type: FinchAPI::Models::HRIS::CompanyBenefit::CompanyContribution::type_? + attr_reader type: FinchAPI::HRIS::CompanyBenefit::CompanyContribution::type_? def type=: ( - FinchAPI::Models::HRIS::CompanyBenefit::CompanyContribution::type_ - ) -> FinchAPI::Models::HRIS::CompanyBenefit::CompanyContribution::type_ + FinchAPI::HRIS::CompanyBenefit::CompanyContribution::type_ + ) -> FinchAPI::HRIS::CompanyBenefit::CompanyContribution::type_ def initialize: ( - ?tiers: ::Array[FinchAPI::Models::HRIS::CompanyBenefit::CompanyContribution::Tier], - ?type: FinchAPI::Models::HRIS::CompanyBenefit::CompanyContribution::type_ + ?tiers: ::Array[FinchAPI::HRIS::CompanyBenefit::CompanyContribution::Tier], + ?type: FinchAPI::HRIS::CompanyBenefit::CompanyContribution::type_ ) -> void - def to_hash: -> FinchAPI::Models::HRIS::CompanyBenefit::company_contribution - type tier = { match: Integer, threshold: Integer } class Tier < FinchAPI::Internal::Type::BaseModel @@ -69,8 +65,6 @@ module FinchAPI def threshold=: (Integer) -> Integer def initialize: (?match: Integer, ?threshold: Integer) -> void - - def to_hash: -> FinchAPI::Models::HRIS::CompanyBenefit::CompanyContribution::tier end type type_ = :match @@ -80,7 +74,7 @@ module FinchAPI MATCH: :match - def self?.values: -> ::Array[FinchAPI::Models::HRIS::CompanyBenefit::CompanyContribution::type_] + def self?.values: -> ::Array[FinchAPI::HRIS::CompanyBenefit::CompanyContribution::type_] end end end diff --git a/sig/finch_api/models/hris/company_retrieve_params.rbs b/sig/finch_api/models/hris/company_retrieve_params.rbs index a6ebf242..f7a69c91 100644 --- a/sig/finch_api/models/hris/company_retrieve_params.rbs +++ b/sig/finch_api/models/hris/company_retrieve_params.rbs @@ -9,8 +9,6 @@ module FinchAPI include FinchAPI::Internal::Type::RequestParameters def initialize: (?request_options: FinchAPI::request_opts) -> void - - def to_hash: -> FinchAPI::Models::HRIS::company_retrieve_params end end 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 6ed3eb29..5cba537b 100644 --- a/sig/finch_api/models/hris/create_company_benefits_response.rbs +++ b/sig/finch_api/models/hris/create_company_benefits_response.rbs @@ -10,8 +10,6 @@ module FinchAPI attr_accessor job_id: String def initialize: (benefit_id: String, job_id: String) -> void - - def to_hash: -> FinchAPI::Models::HRIS::create_company_benefits_response end end 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 a8570d2c..8a0e14c0 100644 --- a/sig/finch_api/models/hris/directory_list_individuals_params.rbs +++ b/sig/finch_api/models/hris/directory_list_individuals_params.rbs @@ -22,8 +22,6 @@ module FinchAPI ?offset: Integer, ?request_options: FinchAPI::request_opts ) -> void - - def to_hash: -> FinchAPI::Models::HRIS::directory_list_individuals_params end end end diff --git a/sig/finch_api/models/hris/directory_list_params.rbs b/sig/finch_api/models/hris/directory_list_params.rbs index 86120246..dd9e479b 100644 --- a/sig/finch_api/models/hris/directory_list_params.rbs +++ b/sig/finch_api/models/hris/directory_list_params.rbs @@ -22,8 +22,6 @@ module FinchAPI ?offset: Integer, ?request_options: FinchAPI::request_opts ) -> void - - def to_hash: -> FinchAPI::Models::HRIS::directory_list_params 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 09e0b123..b3dff5fc 100644 --- a/sig/finch_api/models/hris/document_list_params.rbs +++ b/sig/finch_api/models/hris/document_list_params.rbs @@ -6,7 +6,7 @@ module FinchAPI individual_ids: ::Array[String], limit: Integer, offset: Integer, - types: ::Array[FinchAPI::Models::HRIS::DocumentListParams::type_] + types: ::Array[FinchAPI::HRIS::DocumentListParams::type_] } & FinchAPI::Internal::Type::request_parameters @@ -26,22 +26,20 @@ module FinchAPI def offset=: (Integer) -> Integer - attr_reader types: ::Array[FinchAPI::Models::HRIS::DocumentListParams::type_]? + attr_reader types: ::Array[FinchAPI::HRIS::DocumentListParams::type_]? def types=: ( - ::Array[FinchAPI::Models::HRIS::DocumentListParams::type_] - ) -> ::Array[FinchAPI::Models::HRIS::DocumentListParams::type_] + ::Array[FinchAPI::HRIS::DocumentListParams::type_] + ) -> ::Array[FinchAPI::HRIS::DocumentListParams::type_] def initialize: ( ?individual_ids: ::Array[String], ?limit: Integer, ?offset: Integer, - ?types: ::Array[FinchAPI::Models::HRIS::DocumentListParams::type_], + ?types: ::Array[FinchAPI::HRIS::DocumentListParams::type_], ?request_options: FinchAPI::request_opts ) -> void - def to_hash: -> FinchAPI::Models::HRIS::document_list_params - type type_ = :w4_2020 | :w4_2005 module Type @@ -50,7 +48,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::HRIS::DocumentListParams::type_] end end end diff --git a/sig/finch_api/models/hris/document_list_response.rbs b/sig/finch_api/models/hris/document_list_response.rbs index 6af33f08..992fa975 100644 --- a/sig/finch_api/models/hris/document_list_response.rbs +++ b/sig/finch_api/models/hris/document_list_response.rbs @@ -3,21 +3,19 @@ module FinchAPI module HRIS type document_list_response = { - documents: ::Array[FinchAPI::Models::HRIS::DocumentResponse], - paging: FinchAPI::Models::Paging + documents: ::Array[FinchAPI::HRIS::DocumentResponse], + paging: FinchAPI::Paging } class DocumentListResponse < FinchAPI::Internal::Type::BaseModel - attr_accessor documents: ::Array[FinchAPI::Models::HRIS::DocumentResponse] + attr_accessor documents: ::Array[FinchAPI::HRIS::DocumentResponse] - attr_accessor paging: FinchAPI::Models::Paging + attr_accessor paging: FinchAPI::Paging def initialize: ( - documents: ::Array[FinchAPI::Models::HRIS::DocumentResponse], - paging: FinchAPI::Models::Paging + documents: ::Array[FinchAPI::HRIS::DocumentResponse], + paging: FinchAPI::Paging ) -> void - - def to_hash: -> FinchAPI::Models::HRIS::document_list_response end end end diff --git a/sig/finch_api/models/hris/document_response.rbs b/sig/finch_api/models/hris/document_response.rbs index 00f02a14..909385c8 100644 --- a/sig/finch_api/models/hris/document_response.rbs +++ b/sig/finch_api/models/hris/document_response.rbs @@ -5,7 +5,7 @@ module FinchAPI { id: String, individual_id: String?, - type: FinchAPI::Models::HRIS::DocumentResponse::type_, + type: FinchAPI::HRIS::DocumentResponse::type_, url: String, year: Float? } @@ -17,11 +17,11 @@ module FinchAPI attr_accessor individual_id: String? - attr_reader type: FinchAPI::Models::HRIS::DocumentResponse::type_? + attr_reader type: FinchAPI::HRIS::DocumentResponse::type_? def type=: ( - FinchAPI::Models::HRIS::DocumentResponse::type_ - ) -> FinchAPI::Models::HRIS::DocumentResponse::type_ + FinchAPI::HRIS::DocumentResponse::type_ + ) -> FinchAPI::HRIS::DocumentResponse::type_ attr_reader url: String? @@ -32,13 +32,11 @@ module FinchAPI def initialize: ( ?id: String, ?individual_id: String?, - ?type: FinchAPI::Models::HRIS::DocumentResponse::type_, + ?type: FinchAPI::HRIS::DocumentResponse::type_, ?url: String, ?year: Float? ) -> void - def to_hash: -> FinchAPI::Models::HRIS::document_response - type type_ = :w4_2020 | :w4_2005 module Type @@ -47,7 +45,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::HRIS::DocumentResponse::type_] end end end diff --git a/sig/finch_api/models/hris/document_retreive_params.rbs b/sig/finch_api/models/hris/document_retreive_params.rbs index e9e5344e..f8383893 100644 --- a/sig/finch_api/models/hris/document_retreive_params.rbs +++ b/sig/finch_api/models/hris/document_retreive_params.rbs @@ -9,8 +9,6 @@ module FinchAPI include FinchAPI::Internal::Type::RequestParameters def initialize: (?request_options: FinchAPI::request_opts) -> void - - def to_hash: -> FinchAPI::Models::HRIS::document_retreive_params 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 1b3952c8..3f2ee3d6 100644 --- a/sig/finch_api/models/hris/document_retreive_response.rbs +++ b/sig/finch_api/models/hris/document_retreive_response.rbs @@ -2,12 +2,12 @@ module FinchAPI module Models module HRIS type document_retreive_response = - FinchAPI::Models::HRIS::W42020 | FinchAPI::Models::HRIS::W42005 + FinchAPI::HRIS::W42020 | FinchAPI::HRIS::W42005 module DocumentRetreiveResponse extend FinchAPI::Internal::Type::Union - def self?.variants: -> [FinchAPI::Models::HRIS::W42020, FinchAPI::Models::HRIS::W42005] + def self?.variants: -> ::Array[FinchAPI::Models::HRIS::document_retreive_response] end end end diff --git a/sig/finch_api/models/hris/employment_data.rbs b/sig/finch_api/models/hris/employment_data.rbs index f62b967f..2b51ce9e 100644 --- a/sig/finch_api/models/hris/employment_data.rbs +++ b/sig/finch_api/models/hris/employment_data.rbs @@ -2,208 +2,241 @@ module FinchAPI module Models module HRIS type employment_data = - { - 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? - } + FinchAPI::HRIS::EmploymentData::UnionMember0 + | FinchAPI::HRIS::EmploymentData::BatchError - class EmploymentData < FinchAPI::Internal::Type::BaseModel - attr_reader id: String? + module EmploymentData + extend FinchAPI::Internal::Type::Union - def id=: (String) -> String + type union_member0 = + { + id: String, + class_code: String?, + custom_fields: ::Array[FinchAPI::HRIS::EmploymentData::UnionMember0::CustomField]?, + department: FinchAPI::HRIS::EmploymentData::UnionMember0::Department?, + employment: FinchAPI::HRIS::EmploymentData::UnionMember0::Employment?, + employment_status: FinchAPI::HRIS::EmploymentData::UnionMember0::employment_status?, + end_date: String?, + first_name: String?, + is_active: bool?, + last_name: String?, + latest_rehire_date: String?, + location: FinchAPI::Location?, + manager: FinchAPI::HRIS::EmploymentData::UnionMember0::Manager?, + middle_name: String?, + source_id: String?, + start_date: String?, + title: String?, + work_id: String?, + income: FinchAPI::Income?, + income_history: ::Array[FinchAPI::Income?]? + } - attr_accessor class_code: String? + class UnionMember0 < FinchAPI::Internal::Type::BaseModel + attr_accessor id: String - attr_accessor custom_fields: ::Array[FinchAPI::Models::HRIS::EmploymentData::CustomField]? + attr_accessor class_code: String? - attr_accessor department: FinchAPI::Models::HRIS::EmploymentData::Department? + attr_accessor custom_fields: ::Array[FinchAPI::HRIS::EmploymentData::UnionMember0::CustomField]? - attr_accessor employment: FinchAPI::Models::HRIS::EmploymentData::Employment? + attr_accessor department: FinchAPI::HRIS::EmploymentData::UnionMember0::Department? - attr_accessor employment_status: FinchAPI::Models::HRIS::EmploymentData::employment_status? + attr_accessor employment: FinchAPI::HRIS::EmploymentData::UnionMember0::Employment? - attr_accessor end_date: String? + attr_accessor employment_status: FinchAPI::HRIS::EmploymentData::UnionMember0::employment_status? - attr_accessor first_name: String? + attr_accessor end_date: String? - attr_accessor income: FinchAPI::Models::Income? + attr_accessor first_name: String? - attr_accessor income_history: ::Array[FinchAPI::Models::Income?]? + attr_accessor is_active: bool? - attr_accessor is_active: bool? + attr_accessor last_name: String? - attr_accessor last_name: String? + attr_accessor latest_rehire_date: String? - attr_accessor latest_rehire_date: String? + attr_accessor location: FinchAPI::Location? - attr_accessor location: FinchAPI::Models::Location? + attr_accessor manager: FinchAPI::HRIS::EmploymentData::UnionMember0::Manager? - attr_accessor manager: FinchAPI::Models::HRIS::EmploymentData::Manager? + attr_accessor middle_name: String? - attr_accessor middle_name: String? + attr_accessor source_id: String? - attr_accessor source_id: String? + attr_accessor start_date: String? - attr_accessor start_date: String? + attr_accessor title: String? - attr_accessor title: String? + attr_accessor work_id: String? - attr_accessor work_id: String? + attr_accessor income: FinchAPI::Income? - 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 + attr_accessor income_history: ::Array[FinchAPI::Income?]? - def to_hash: -> FinchAPI::Models::HRIS::employment_data + def initialize: ( + id: String, + class_code: String?, + custom_fields: ::Array[FinchAPI::HRIS::EmploymentData::UnionMember0::CustomField]?, + department: FinchAPI::HRIS::EmploymentData::UnionMember0::Department?, + employment: FinchAPI::HRIS::EmploymentData::UnionMember0::Employment?, + employment_status: FinchAPI::HRIS::EmploymentData::UnionMember0::employment_status?, + end_date: String?, + first_name: String?, + is_active: bool?, + last_name: String?, + latest_rehire_date: String?, + location: FinchAPI::Location?, + manager: FinchAPI::HRIS::EmploymentData::UnionMember0::Manager?, + middle_name: String?, + source_id: String?, + start_date: String?, + title: String?, + work_id: String?, + ?income: FinchAPI::Income?, + ?income_history: ::Array[FinchAPI::Income?]? + ) -> void - type custom_field = { name: String, value: top } + type custom_field = + { + name: String, + value: FinchAPI::HRIS::EmploymentData::UnionMember0::CustomField::value? + } - class CustomField < FinchAPI::Internal::Type::BaseModel - attr_reader name: String? + class CustomField < FinchAPI::Internal::Type::BaseModel + attr_reader name: String? - def name=: (String) -> String + def name=: (String) -> String - attr_reader value: top? + attr_accessor value: FinchAPI::HRIS::EmploymentData::UnionMember0::CustomField::value? - def value=: (top) -> top + def initialize: ( + ?name: String, + ?value: FinchAPI::HRIS::EmploymentData::UnionMember0::CustomField::value? + ) -> void - def initialize: (?name: String, ?value: top) -> void + type value = String | ::Array[top] | top | Float | bool - def to_hash: -> FinchAPI::Models::HRIS::EmploymentData::custom_field - end + module Value + extend FinchAPI::Internal::Type::Union - type department = { name: String? } + def self?.variants: -> ::Array[FinchAPI::HRIS::EmploymentData::UnionMember0::CustomField::value] - class Department < FinchAPI::Internal::Type::BaseModel - attr_accessor name: String? + UnionMember1Array: FinchAPI::Internal::Type::Converter + end + end - def initialize: (?name: String?) -> void + type department = { name: String? } - def to_hash: -> FinchAPI::Models::HRIS::EmploymentData::department - end + class Department < FinchAPI::Internal::Type::BaseModel + attr_accessor name: String? - type employment = - { - subtype: FinchAPI::Models::HRIS::EmploymentData::Employment::subtype?, - type: FinchAPI::Models::HRIS::EmploymentData::Employment::type_? - } + def initialize: (name: String?) -> void + end - class Employment < FinchAPI::Internal::Type::BaseModel - attr_accessor subtype: FinchAPI::Models::HRIS::EmploymentData::Employment::subtype? + type employment = + { + subtype: FinchAPI::HRIS::EmploymentData::UnionMember0::Employment::subtype?, + type: FinchAPI::HRIS::EmploymentData::UnionMember0::Employment::type_? + } - attr_accessor type: FinchAPI::Models::HRIS::EmploymentData::Employment::type_? + class Employment < FinchAPI::Internal::Type::BaseModel + attr_accessor subtype: FinchAPI::HRIS::EmploymentData::UnionMember0::Employment::subtype? - def initialize: ( - ?subtype: FinchAPI::Models::HRIS::EmploymentData::Employment::subtype?, - ?type: FinchAPI::Models::HRIS::EmploymentData::Employment::type_? - ) -> void + attr_accessor type: FinchAPI::HRIS::EmploymentData::UnionMember0::Employment::type_? - def to_hash: -> FinchAPI::Models::HRIS::EmploymentData::employment + def initialize: ( + subtype: FinchAPI::HRIS::EmploymentData::UnionMember0::Employment::subtype?, + type: FinchAPI::HRIS::EmploymentData::UnionMember0::Employment::type_? + ) -> void - type subtype = - :full_time - | :intern - | :part_time - | :temp - | :seasonal - | :individual_contractor + type subtype = + :full_time + | :intern + | :part_time + | :temp + | :seasonal + | :individual_contractor - module Subtype - extend FinchAPI::Internal::Type::Enum + module Subtype + extend FinchAPI::Internal::Type::Enum - FULL_TIME: :full_time - INTERN: :intern - PART_TIME: :part_time - TEMP: :temp - SEASONAL: :seasonal - INDIVIDUAL_CONTRACTOR: :individual_contractor + FULL_TIME: :full_time + INTERN: :intern + PART_TIME: :part_time + TEMP: :temp + SEASONAL: :seasonal + INDIVIDUAL_CONTRACTOR: :individual_contractor - def self?.values: -> ::Array[FinchAPI::Models::HRIS::EmploymentData::Employment::subtype] + def self?.values: -> ::Array[FinchAPI::HRIS::EmploymentData::UnionMember0::Employment::subtype] + end + + type type_ = :employee | :contractor + + module Type + extend FinchAPI::Internal::Type::Enum + + EMPLOYEE: :employee + CONTRACTOR: :contractor + + def self?.values: -> ::Array[FinchAPI::HRIS::EmploymentData::UnionMember0::Employment::type_] + end end - type type_ = :employee | :contractor + type employment_status = + :active + | :deceased + | :leave + | :onboarding + | :prehire + | :retired + | :terminated - module Type + module EmploymentStatus extend FinchAPI::Internal::Type::Enum - EMPLOYEE: :employee - CONTRACTOR: :contractor + ACTIVE: :active + DECEASED: :deceased + LEAVE: :leave + ONBOARDING: :onboarding + PREHIRE: :prehire + RETIRED: :retired + TERMINATED: :terminated - def self?.values: -> ::Array[FinchAPI::Models::HRIS::EmploymentData::Employment::type_] + def self?.values: -> ::Array[FinchAPI::HRIS::EmploymentData::UnionMember0::employment_status] end - end - type employment_status = - :active - | :deceased - | :leave - | :onboarding - | :prehire - | :retired - | :terminated - - module EmploymentStatus - extend FinchAPI::Internal::Type::Enum - - ACTIVE: :active - DECEASED: :deceased - LEAVE: :leave - ONBOARDING: :onboarding - PREHIRE: :prehire - RETIRED: :retired - TERMINATED: :terminated - - def self?.values: -> ::Array[FinchAPI::Models::HRIS::EmploymentData::employment_status] + type manager = { id: String } + + class Manager < FinchAPI::Internal::Type::BaseModel + attr_accessor id: String + + def initialize: (id: String) -> void + end end - type manager = { id: String } + type batch_error = + { code: Float, message: String, name: String, finch_code: String } + + class BatchError < FinchAPI::Internal::Type::BaseModel + attr_accessor code: Float + + attr_accessor message: String - class Manager < FinchAPI::Internal::Type::BaseModel - attr_reader id: String? + attr_accessor name: String - def id=: (String) -> String + attr_reader finch_code: String? - def initialize: (?id: String) -> void + def finch_code=: (String) -> String - def to_hash: -> FinchAPI::Models::HRIS::EmploymentData::manager + def initialize: ( + code: Float, + message: String, + name: String, + ?finch_code: String + ) -> void end + + def self?.variants: -> ::Array[FinchAPI::Models::HRIS::employment_data] end end end diff --git a/sig/finch_api/models/hris/employment_data_response.rbs b/sig/finch_api/models/hris/employment_data_response.rbs index 1c9c58b3..58fce503 100644 --- a/sig/finch_api/models/hris/employment_data_response.rbs +++ b/sig/finch_api/models/hris/employment_data_response.rbs @@ -3,33 +3,23 @@ module FinchAPI module HRIS type employment_data_response = { - body: FinchAPI::Models::HRIS::EmploymentData, + body: FinchAPI::Models::HRIS::employment_data, code: Integer, individual_id: String } class EmploymentDataResponse < FinchAPI::Internal::Type::BaseModel - attr_reader body: FinchAPI::Models::HRIS::EmploymentData? + attr_accessor body: FinchAPI::Models::HRIS::employment_data - def body=: ( - FinchAPI::Models::HRIS::EmploymentData - ) -> FinchAPI::Models::HRIS::EmploymentData + attr_accessor code: Integer - attr_reader code: Integer? - - def code=: (Integer) -> Integer - - attr_reader individual_id: String? - - def individual_id=: (String) -> String + attr_accessor individual_id: String def initialize: ( - ?body: FinchAPI::Models::HRIS::EmploymentData, - ?code: Integer, - ?individual_id: String + body: FinchAPI::Models::HRIS::employment_data, + code: Integer, + individual_id: String ) -> void - - def to_hash: -> FinchAPI::Models::HRIS::employment_data_response end end 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 86582926..1ca4bad6 100644 --- a/sig/finch_api/models/hris/employment_retrieve_many_params.rbs +++ b/sig/finch_api/models/hris/employment_retrieve_many_params.rbs @@ -3,7 +3,7 @@ module FinchAPI module HRIS type employment_retrieve_many_params = { - requests: ::Array[FinchAPI::Models::HRIS::EmploymentRetrieveManyParams::Request] + requests: ::Array[FinchAPI::HRIS::EmploymentRetrieveManyParams::Request] } & FinchAPI::Internal::Type::request_parameters @@ -11,23 +11,19 @@ module FinchAPI extend FinchAPI::Internal::Type::RequestParameters::Converter include FinchAPI::Internal::Type::RequestParameters - attr_accessor requests: ::Array[FinchAPI::Models::HRIS::EmploymentRetrieveManyParams::Request] + attr_accessor requests: ::Array[FinchAPI::HRIS::EmploymentRetrieveManyParams::Request] def initialize: ( - requests: ::Array[FinchAPI::Models::HRIS::EmploymentRetrieveManyParams::Request], + requests: ::Array[FinchAPI::HRIS::EmploymentRetrieveManyParams::Request], ?request_options: FinchAPI::request_opts ) -> void - def to_hash: -> FinchAPI::Models::HRIS::employment_retrieve_many_params - type request = { individual_id: String } class Request < FinchAPI::Internal::Type::BaseModel attr_accessor individual_id: String def initialize: (individual_id: String) -> void - - def to_hash: -> FinchAPI::Models::HRIS::EmploymentRetrieveManyParams::request end end end diff --git a/sig/finch_api/models/hris/individual.rbs b/sig/finch_api/models/hris/individual.rbs index 03ef68f5..439efbdb 100644 --- a/sig/finch_api/models/hris/individual.rbs +++ b/sig/finch_api/models/hris/individual.rbs @@ -2,8 +2,8 @@ module FinchAPI module Models module HRIS type individual = - FinchAPI::Models::HRIS::Individual::UnionMember0 - | FinchAPI::Models::HRIS::Individual::BatchError + FinchAPI::HRIS::Individual::UnionMember0 + | FinchAPI::HRIS::Individual::BatchError module Individual extend FinchAPI::Internal::Type::Union @@ -12,15 +12,15 @@ module FinchAPI { id: String, dob: String?, - ethnicity: FinchAPI::Models::HRIS::Individual::UnionMember0::ethnicity?, + ethnicity: FinchAPI::HRIS::Individual::UnionMember0::ethnicity?, first_name: String?, - gender: FinchAPI::Models::HRIS::Individual::UnionMember0::gender?, + gender: FinchAPI::HRIS::Individual::UnionMember0::gender?, last_name: String?, middle_name: String?, - phone_numbers: ::Array[FinchAPI::Models::HRIS::Individual::UnionMember0::PhoneNumber?]?, + phone_numbers: ::Array[FinchAPI::HRIS::Individual::UnionMember0::PhoneNumber?]?, preferred_name: String?, - residence: FinchAPI::Models::Location?, - emails: ::Array[FinchAPI::Models::HRIS::Individual::UnionMember0::Email]?, + residence: FinchAPI::Location?, + emails: ::Array[FinchAPI::HRIS::Individual::UnionMember0::Email]?, encrypted_ssn: String?, ssn: String? } @@ -30,23 +30,23 @@ module FinchAPI attr_accessor dob: String? - attr_accessor ethnicity: FinchAPI::Models::HRIS::Individual::UnionMember0::ethnicity? + attr_accessor ethnicity: FinchAPI::HRIS::Individual::UnionMember0::ethnicity? attr_accessor first_name: String? - attr_accessor gender: FinchAPI::Models::HRIS::Individual::UnionMember0::gender? + attr_accessor gender: FinchAPI::HRIS::Individual::UnionMember0::gender? attr_accessor last_name: String? attr_accessor middle_name: String? - attr_accessor phone_numbers: ::Array[FinchAPI::Models::HRIS::Individual::UnionMember0::PhoneNumber?]? + attr_accessor phone_numbers: ::Array[FinchAPI::HRIS::Individual::UnionMember0::PhoneNumber?]? attr_accessor preferred_name: String? - attr_accessor residence: FinchAPI::Models::Location? + attr_accessor residence: FinchAPI::Location? - attr_accessor emails: ::Array[FinchAPI::Models::HRIS::Individual::UnionMember0::Email]? + attr_accessor emails: ::Array[FinchAPI::HRIS::Individual::UnionMember0::Email]? attr_accessor encrypted_ssn: String? @@ -55,21 +55,19 @@ module FinchAPI def initialize: ( id: String, dob: String?, - ethnicity: FinchAPI::Models::HRIS::Individual::UnionMember0::ethnicity?, + ethnicity: FinchAPI::HRIS::Individual::UnionMember0::ethnicity?, first_name: String?, - gender: FinchAPI::Models::HRIS::Individual::UnionMember0::gender?, + gender: FinchAPI::HRIS::Individual::UnionMember0::gender?, last_name: String?, middle_name: String?, - phone_numbers: ::Array[FinchAPI::Models::HRIS::Individual::UnionMember0::PhoneNumber?]?, + phone_numbers: ::Array[FinchAPI::HRIS::Individual::UnionMember0::PhoneNumber?]?, preferred_name: String?, - residence: FinchAPI::Models::Location?, - ?emails: ::Array[FinchAPI::Models::HRIS::Individual::UnionMember0::Email]?, + residence: FinchAPI::Location?, + ?emails: ::Array[FinchAPI::HRIS::Individual::UnionMember0::Email]?, ?encrypted_ssn: String?, ?ssn: String? ) -> void - def to_hash: -> FinchAPI::Models::HRIS::Individual::union_member0 - type ethnicity = :asian | :white @@ -92,7 +90,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::UnionMember0::ethnicity] + def self?.values: -> ::Array[FinchAPI::HRIS::Individual::UnionMember0::ethnicity] end type gender = :female | :male | :other | :decline_to_specify @@ -105,27 +103,25 @@ module FinchAPI OTHER: :other DECLINE_TO_SPECIFY: :decline_to_specify - def self?.values: -> ::Array[FinchAPI::Models::HRIS::Individual::UnionMember0::gender] + def self?.values: -> ::Array[FinchAPI::HRIS::Individual::UnionMember0::gender] end type phone_number = { data: String?, - type: FinchAPI::Models::HRIS::Individual::UnionMember0::PhoneNumber::type_? + type: FinchAPI::HRIS::Individual::UnionMember0::PhoneNumber::type_? } class PhoneNumber < FinchAPI::Internal::Type::BaseModel attr_accessor data: String? - attr_accessor type: FinchAPI::Models::HRIS::Individual::UnionMember0::PhoneNumber::type_? + attr_accessor type: FinchAPI::HRIS::Individual::UnionMember0::PhoneNumber::type_? def initialize: ( data: String?, - type: FinchAPI::Models::HRIS::Individual::UnionMember0::PhoneNumber::type_? + type: FinchAPI::HRIS::Individual::UnionMember0::PhoneNumber::type_? ) -> void - def to_hash: -> FinchAPI::Models::HRIS::Individual::UnionMember0::phone_number - type type_ = :work | :personal module Type @@ -134,28 +130,26 @@ module FinchAPI WORK: :work PERSONAL: :personal - def self?.values: -> ::Array[FinchAPI::Models::HRIS::Individual::UnionMember0::PhoneNumber::type_] + def self?.values: -> ::Array[FinchAPI::HRIS::Individual::UnionMember0::PhoneNumber::type_] end end type email = { data: String, - type: FinchAPI::Models::HRIS::Individual::UnionMember0::Email::type_? + type: FinchAPI::HRIS::Individual::UnionMember0::Email::type_? } class Email < FinchAPI::Internal::Type::BaseModel attr_accessor data: String - attr_accessor type: FinchAPI::Models::HRIS::Individual::UnionMember0::Email::type_? + attr_accessor type: FinchAPI::HRIS::Individual::UnionMember0::Email::type_? def initialize: ( data: String, - type: FinchAPI::Models::HRIS::Individual::UnionMember0::Email::type_? + type: FinchAPI::HRIS::Individual::UnionMember0::Email::type_? ) -> void - def to_hash: -> FinchAPI::Models::HRIS::Individual::UnionMember0::email - type type_ = :work | :personal module Type @@ -164,7 +158,7 @@ module FinchAPI WORK: :work PERSONAL: :personal - def self?.values: -> ::Array[FinchAPI::Models::HRIS::Individual::UnionMember0::Email::type_] + def self?.values: -> ::Array[FinchAPI::HRIS::Individual::UnionMember0::Email::type_] end end end @@ -189,11 +183,9 @@ module FinchAPI name: String, ?finch_code: String ) -> void - - def to_hash: -> FinchAPI::Models::HRIS::Individual::batch_error end - def self?.variants: -> [FinchAPI::Models::HRIS::Individual::UnionMember0, FinchAPI::Models::HRIS::Individual::BatchError] + def self?.variants: -> ::Array[FinchAPI::Models::HRIS::individual] end end end diff --git a/sig/finch_api/models/hris/individual_in_directory.rbs b/sig/finch_api/models/hris/individual_in_directory.rbs index 4a19aa5b..1339b5c5 100644 --- a/sig/finch_api/models/hris/individual_in_directory.rbs +++ b/sig/finch_api/models/hris/individual_in_directory.rbs @@ -4,18 +4,18 @@ module FinchAPI type individual_in_directory = { id: String, - department: FinchAPI::Models::HRIS::IndividualInDirectory::Department?, + department: FinchAPI::HRIS::IndividualInDirectory::Department?, first_name: String?, is_active: bool?, last_name: String?, - manager: FinchAPI::Models::HRIS::IndividualInDirectory::Manager?, + manager: FinchAPI::HRIS::IndividualInDirectory::Manager?, middle_name: String? } class IndividualInDirectory < FinchAPI::Internal::Type::BaseModel attr_accessor id: String - attr_accessor department: FinchAPI::Models::HRIS::IndividualInDirectory::Department? + attr_accessor department: FinchAPI::HRIS::IndividualInDirectory::Department? attr_accessor first_name: String? @@ -23,30 +23,26 @@ module FinchAPI attr_accessor last_name: String? - attr_accessor manager: FinchAPI::Models::HRIS::IndividualInDirectory::Manager? + attr_accessor manager: FinchAPI::HRIS::IndividualInDirectory::Manager? attr_accessor middle_name: String? def initialize: ( id: String, - department: FinchAPI::Models::HRIS::IndividualInDirectory::Department?, + department: FinchAPI::HRIS::IndividualInDirectory::Department?, first_name: String?, is_active: bool?, last_name: String?, - manager: FinchAPI::Models::HRIS::IndividualInDirectory::Manager?, + manager: FinchAPI::HRIS::IndividualInDirectory::Manager?, middle_name: String? ) -> void - def to_hash: -> FinchAPI::Models::HRIS::individual_in_directory - type department = { name: String? } class Department < FinchAPI::Internal::Type::BaseModel attr_accessor name: String? def initialize: (?name: String?) -> void - - def to_hash: -> FinchAPI::Models::HRIS::IndividualInDirectory::department end type manager = { id: String } @@ -55,8 +51,6 @@ module FinchAPI attr_accessor id: String def initialize: (id: String) -> void - - def to_hash: -> FinchAPI::Models::HRIS::IndividualInDirectory::manager end end end diff --git a/sig/finch_api/models/hris/individual_response.rbs b/sig/finch_api/models/hris/individual_response.rbs index 27936a73..25287ab6 100644 --- a/sig/finch_api/models/hris/individual_response.rbs +++ b/sig/finch_api/models/hris/individual_response.rbs @@ -20,8 +20,6 @@ module FinchAPI code: Integer, individual_id: String ) -> void - - def to_hash: -> FinchAPI::Models::HRIS::individual_response end end 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 81333d0d..49c25a4e 100644 --- a/sig/finch_api/models/hris/individual_retrieve_many_params.rbs +++ b/sig/finch_api/models/hris/individual_retrieve_many_params.rbs @@ -3,8 +3,8 @@ module FinchAPI module HRIS type individual_retrieve_many_params = { - options: FinchAPI::Models::HRIS::IndividualRetrieveManyParams::Options?, - requests: ::Array[FinchAPI::Models::HRIS::IndividualRetrieveManyParams::Request] + options: FinchAPI::HRIS::IndividualRetrieveManyParams::Options?, + requests: ::Array[FinchAPI::HRIS::IndividualRetrieveManyParams::Request] } & FinchAPI::Internal::Type::request_parameters @@ -12,22 +12,20 @@ module FinchAPI extend FinchAPI::Internal::Type::RequestParameters::Converter include FinchAPI::Internal::Type::RequestParameters - attr_accessor options: FinchAPI::Models::HRIS::IndividualRetrieveManyParams::Options? + attr_accessor options: FinchAPI::HRIS::IndividualRetrieveManyParams::Options? - attr_reader requests: ::Array[FinchAPI::Models::HRIS::IndividualRetrieveManyParams::Request]? + attr_reader requests: ::Array[FinchAPI::HRIS::IndividualRetrieveManyParams::Request]? def requests=: ( - ::Array[FinchAPI::Models::HRIS::IndividualRetrieveManyParams::Request] - ) -> ::Array[FinchAPI::Models::HRIS::IndividualRetrieveManyParams::Request] + ::Array[FinchAPI::HRIS::IndividualRetrieveManyParams::Request] + ) -> ::Array[FinchAPI::HRIS::IndividualRetrieveManyParams::Request] def initialize: ( - ?options: FinchAPI::Models::HRIS::IndividualRetrieveManyParams::Options?, - ?requests: ::Array[FinchAPI::Models::HRIS::IndividualRetrieveManyParams::Request], + ?options: FinchAPI::HRIS::IndividualRetrieveManyParams::Options?, + ?requests: ::Array[FinchAPI::HRIS::IndividualRetrieveManyParams::Request], ?request_options: FinchAPI::request_opts ) -> void - def to_hash: -> FinchAPI::Models::HRIS::individual_retrieve_many_params - type options = { include: ::Array[String] } class Options < FinchAPI::Internal::Type::BaseModel @@ -36,8 +34,6 @@ module FinchAPI def include=: (::Array[String]) -> ::Array[String] def initialize: (?include: ::Array[String]) -> void - - def to_hash: -> FinchAPI::Models::HRIS::IndividualRetrieveManyParams::options end type request = { individual_id: String } @@ -48,8 +44,6 @@ module FinchAPI def individual_id=: (String) -> String def initialize: (?individual_id: String) -> void - - def to_hash: -> FinchAPI::Models::HRIS::IndividualRetrieveManyParams::request end end end diff --git a/sig/finch_api/models/hris/pay_statement.rbs b/sig/finch_api/models/hris/pay_statement.rbs index 3eece4f7..5542547c 100644 --- a/sig/finch_api/models/hris/pay_statement.rbs +++ b/sig/finch_api/models/hris/pay_statement.rbs @@ -3,70 +3,68 @@ module FinchAPI module HRIS type pay_statement = { - 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?, + earnings: ::Array[FinchAPI::HRIS::PayStatement::Earning?]?, + employee_deductions: ::Array[FinchAPI::HRIS::PayStatement::EmployeeDeduction?]?, + employer_contributions: ::Array[FinchAPI::HRIS::PayStatement::EmployerContribution?]?, + gross_pay: FinchAPI::Money?, individual_id: String, - net_pay: FinchAPI::Models::Money?, - payment_method: FinchAPI::Models::HRIS::PayStatement::payment_method?, - taxes: ::Array[FinchAPI::Models::HRIS::PayStatement::Tax?]?, + net_pay: FinchAPI::Money?, + payment_method: FinchAPI::HRIS::PayStatement::payment_method?, + taxes: ::Array[FinchAPI::HRIS::PayStatement::Tax?]?, total_hours: Float?, - type: FinchAPI::Models::HRIS::PayStatement::type_? + type: FinchAPI::HRIS::PayStatement::type_? } class PayStatement < FinchAPI::Internal::Type::BaseModel - attr_accessor earnings: ::Array[FinchAPI::Models::HRIS::PayStatement::Earning?]? + attr_accessor earnings: ::Array[FinchAPI::HRIS::PayStatement::Earning?]? - attr_accessor employee_deductions: ::Array[FinchAPI::Models::HRIS::PayStatement::EmployeeDeduction?]? + attr_accessor employee_deductions: ::Array[FinchAPI::HRIS::PayStatement::EmployeeDeduction?]? - attr_accessor employer_contributions: ::Array[FinchAPI::Models::HRIS::PayStatement::EmployerContribution?]? + attr_accessor employer_contributions: ::Array[FinchAPI::HRIS::PayStatement::EmployerContribution?]? - attr_accessor gross_pay: FinchAPI::Models::Money? + attr_accessor gross_pay: FinchAPI::Money? attr_reader individual_id: String? def individual_id=: (String) -> String - attr_accessor net_pay: FinchAPI::Models::Money? + attr_accessor net_pay: FinchAPI::Money? - attr_accessor payment_method: FinchAPI::Models::HRIS::PayStatement::payment_method? + attr_accessor payment_method: FinchAPI::HRIS::PayStatement::payment_method? - attr_accessor taxes: ::Array[FinchAPI::Models::HRIS::PayStatement::Tax?]? + attr_accessor taxes: ::Array[FinchAPI::HRIS::PayStatement::Tax?]? attr_accessor total_hours: Float? - attr_accessor type: FinchAPI::Models::HRIS::PayStatement::type_? + attr_accessor type: FinchAPI::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?, + ?earnings: ::Array[FinchAPI::HRIS::PayStatement::Earning?]?, + ?employee_deductions: ::Array[FinchAPI::HRIS::PayStatement::EmployeeDeduction?]?, + ?employer_contributions: ::Array[FinchAPI::HRIS::PayStatement::EmployerContribution?]?, + ?gross_pay: FinchAPI::Money?, ?individual_id: String, - ?net_pay: FinchAPI::Models::Money?, - ?payment_method: FinchAPI::Models::HRIS::PayStatement::payment_method?, - ?taxes: ::Array[FinchAPI::Models::HRIS::PayStatement::Tax?]?, + ?net_pay: FinchAPI::Money?, + ?payment_method: FinchAPI::HRIS::PayStatement::payment_method?, + ?taxes: ::Array[FinchAPI::HRIS::PayStatement::Tax?]?, ?total_hours: Float?, - ?type: FinchAPI::Models::HRIS::PayStatement::type_? + ?type: FinchAPI::HRIS::PayStatement::type_? ) -> void - def to_hash: -> FinchAPI::Models::HRIS::pay_statement - type earning = { amount: Integer?, - attributes: FinchAPI::Models::HRIS::PayStatement::Earning::Attributes?, + attributes: FinchAPI::HRIS::PayStatement::Earning::Attributes?, currency: String?, hours: Float?, name: String?, - type: FinchAPI::Models::HRIS::PayStatement::Earning::type_? + type: FinchAPI::HRIS::PayStatement::Earning::type_? } class Earning < FinchAPI::Internal::Type::BaseModel attr_accessor amount: Integer? - attr_accessor attributes: FinchAPI::Models::HRIS::PayStatement::Earning::Attributes? + attr_accessor attributes: FinchAPI::HRIS::PayStatement::Earning::Attributes? attr_accessor currency: String? @@ -74,47 +72,41 @@ module FinchAPI attr_accessor name: String? - attr_accessor type: FinchAPI::Models::HRIS::PayStatement::Earning::type_? + attr_accessor type: FinchAPI::HRIS::PayStatement::Earning::type_? def initialize: ( ?amount: Integer?, - ?attributes: FinchAPI::Models::HRIS::PayStatement::Earning::Attributes?, + ?attributes: FinchAPI::HRIS::PayStatement::Earning::Attributes?, ?currency: String?, ?hours: Float?, ?name: String?, - ?type: FinchAPI::Models::HRIS::PayStatement::Earning::type_? + ?type: FinchAPI::HRIS::PayStatement::Earning::type_? ) -> void - def to_hash: -> FinchAPI::Models::HRIS::PayStatement::earning - type attributes = { - metadata: FinchAPI::Models::HRIS::PayStatement::Earning::Attributes::Metadata + metadata: FinchAPI::HRIS::PayStatement::Earning::Attributes::Metadata } class Attributes < FinchAPI::Internal::Type::BaseModel - attr_reader metadata: FinchAPI::Models::HRIS::PayStatement::Earning::Attributes::Metadata? + attr_reader metadata: FinchAPI::HRIS::PayStatement::Earning::Attributes::Metadata? def metadata=: ( - FinchAPI::Models::HRIS::PayStatement::Earning::Attributes::Metadata - ) -> FinchAPI::Models::HRIS::PayStatement::Earning::Attributes::Metadata + FinchAPI::HRIS::PayStatement::Earning::Attributes::Metadata + ) -> FinchAPI::HRIS::PayStatement::Earning::Attributes::Metadata def initialize: ( - ?metadata: FinchAPI::Models::HRIS::PayStatement::Earning::Attributes::Metadata + ?metadata: FinchAPI::HRIS::PayStatement::Earning::Attributes::Metadata ) -> void - def to_hash: -> FinchAPI::Models::HRIS::PayStatement::Earning::attributes - - type metadata = { metadata: ::Hash[Symbol, top] } + type metadata = { metadata: ::Hash[Symbol, top?] } class Metadata < FinchAPI::Internal::Type::BaseModel - attr_reader metadata: ::Hash[Symbol, top]? - - def metadata=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top] + attr_reader metadata: ::Hash[Symbol, top?]? - def initialize: (?metadata: ::Hash[Symbol, top]) -> void + def metadata=: (::Hash[Symbol, top?]) -> ::Hash[Symbol, top?] - def to_hash: -> FinchAPI::Models::HRIS::PayStatement::Earning::Attributes::metadata + def initialize: (?metadata: ::Hash[Symbol, top?]) -> void end end @@ -150,14 +142,14 @@ module FinchAPI TYPE_1099: :"1099" OTHER: :other - def self?.values: -> ::Array[FinchAPI::Models::HRIS::PayStatement::Earning::type_] + def self?.values: -> ::Array[FinchAPI::HRIS::PayStatement::Earning::type_] end end type employee_deduction = { amount: Integer?, - attributes: FinchAPI::Models::HRIS::PayStatement::EmployeeDeduction::Attributes?, + attributes: FinchAPI::HRIS::PayStatement::EmployeeDeduction::Attributes?, currency: String?, name: String?, pre_tax: bool?, @@ -167,7 +159,7 @@ module FinchAPI class EmployeeDeduction < FinchAPI::Internal::Type::BaseModel attr_accessor amount: Integer? - attr_accessor attributes: FinchAPI::Models::HRIS::PayStatement::EmployeeDeduction::Attributes? + attr_accessor attributes: FinchAPI::HRIS::PayStatement::EmployeeDeduction::Attributes? attr_accessor currency: String? @@ -179,43 +171,37 @@ module FinchAPI def initialize: ( ?amount: Integer?, - ?attributes: FinchAPI::Models::HRIS::PayStatement::EmployeeDeduction::Attributes?, + ?attributes: FinchAPI::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 - type attributes = { - metadata: FinchAPI::Models::HRIS::PayStatement::EmployeeDeduction::Attributes::Metadata + metadata: FinchAPI::HRIS::PayStatement::EmployeeDeduction::Attributes::Metadata } class Attributes < FinchAPI::Internal::Type::BaseModel - attr_reader metadata: FinchAPI::Models::HRIS::PayStatement::EmployeeDeduction::Attributes::Metadata? + attr_reader metadata: FinchAPI::HRIS::PayStatement::EmployeeDeduction::Attributes::Metadata? def metadata=: ( - FinchAPI::Models::HRIS::PayStatement::EmployeeDeduction::Attributes::Metadata - ) -> FinchAPI::Models::HRIS::PayStatement::EmployeeDeduction::Attributes::Metadata + FinchAPI::HRIS::PayStatement::EmployeeDeduction::Attributes::Metadata + ) -> FinchAPI::HRIS::PayStatement::EmployeeDeduction::Attributes::Metadata def initialize: ( - ?metadata: FinchAPI::Models::HRIS::PayStatement::EmployeeDeduction::Attributes::Metadata + ?metadata: FinchAPI::HRIS::PayStatement::EmployeeDeduction::Attributes::Metadata ) -> void - def to_hash: -> FinchAPI::Models::HRIS::PayStatement::EmployeeDeduction::attributes - - type metadata = { metadata: ::Hash[Symbol, top] } + type metadata = { metadata: ::Hash[Symbol, top?] } class Metadata < FinchAPI::Internal::Type::BaseModel - attr_reader metadata: ::Hash[Symbol, top]? - - def metadata=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top] + attr_reader metadata: ::Hash[Symbol, top?]? - def initialize: (?metadata: ::Hash[Symbol, top]) -> void + def metadata=: (::Hash[Symbol, top?]) -> ::Hash[Symbol, top?] - def to_hash: -> FinchAPI::Models::HRIS::PayStatement::EmployeeDeduction::Attributes::metadata + def initialize: (?metadata: ::Hash[Symbol, top?]) -> void end end end @@ -223,7 +209,7 @@ module FinchAPI type employer_contribution = { amount: Integer?, - attributes: FinchAPI::Models::HRIS::PayStatement::EmployerContribution::Attributes?, + attributes: FinchAPI::HRIS::PayStatement::EmployerContribution::Attributes?, currency: String?, name: String?, type: FinchAPI::Models::HRIS::benefit_type? @@ -232,7 +218,7 @@ module FinchAPI class EmployerContribution < FinchAPI::Internal::Type::BaseModel attr_accessor amount: Integer? - attr_accessor attributes: FinchAPI::Models::HRIS::PayStatement::EmployerContribution::Attributes? + attr_accessor attributes: FinchAPI::HRIS::PayStatement::EmployerContribution::Attributes? attr_accessor currency: String? @@ -242,42 +228,36 @@ module FinchAPI def initialize: ( ?amount: Integer?, - ?attributes: FinchAPI::Models::HRIS::PayStatement::EmployerContribution::Attributes?, + ?attributes: FinchAPI::HRIS::PayStatement::EmployerContribution::Attributes?, ?currency: String?, ?name: String?, ?type: FinchAPI::Models::HRIS::benefit_type? ) -> void - def to_hash: -> FinchAPI::Models::HRIS::PayStatement::employer_contribution - type attributes = { - metadata: FinchAPI::Models::HRIS::PayStatement::EmployerContribution::Attributes::Metadata + metadata: FinchAPI::HRIS::PayStatement::EmployerContribution::Attributes::Metadata } class Attributes < FinchAPI::Internal::Type::BaseModel - attr_reader metadata: FinchAPI::Models::HRIS::PayStatement::EmployerContribution::Attributes::Metadata? + attr_reader metadata: FinchAPI::HRIS::PayStatement::EmployerContribution::Attributes::Metadata? def metadata=: ( - FinchAPI::Models::HRIS::PayStatement::EmployerContribution::Attributes::Metadata - ) -> FinchAPI::Models::HRIS::PayStatement::EmployerContribution::Attributes::Metadata + FinchAPI::HRIS::PayStatement::EmployerContribution::Attributes::Metadata + ) -> FinchAPI::HRIS::PayStatement::EmployerContribution::Attributes::Metadata def initialize: ( - ?metadata: FinchAPI::Models::HRIS::PayStatement::EmployerContribution::Attributes::Metadata + ?metadata: FinchAPI::HRIS::PayStatement::EmployerContribution::Attributes::Metadata ) -> void - def to_hash: -> FinchAPI::Models::HRIS::PayStatement::EmployerContribution::attributes - - type metadata = { metadata: ::Hash[Symbol, top] } + type metadata = { metadata: ::Hash[Symbol, top?] } class Metadata < FinchAPI::Internal::Type::BaseModel - attr_reader metadata: ::Hash[Symbol, top]? - - def metadata=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top] + attr_reader metadata: ::Hash[Symbol, top?]? - def initialize: (?metadata: ::Hash[Symbol, top]) -> void + def metadata=: (::Hash[Symbol, top?]) -> ::Hash[Symbol, top?] - def to_hash: -> FinchAPI::Models::HRIS::PayStatement::EmployerContribution::Attributes::metadata + def initialize: (?metadata: ::Hash[Symbol, top?]) -> void end end end @@ -290,23 +270,23 @@ module FinchAPI CHECK: :check DIRECT_DEPOSIT: :direct_deposit - def self?.values: -> ::Array[FinchAPI::Models::HRIS::PayStatement::payment_method] + def self?.values: -> ::Array[FinchAPI::HRIS::PayStatement::payment_method] end type tax = { amount: Integer?, - attributes: FinchAPI::Models::HRIS::PayStatement::Tax::Attributes?, + attributes: FinchAPI::HRIS::PayStatement::Tax::Attributes?, currency: String?, employer: bool?, name: String?, - type: FinchAPI::Models::HRIS::PayStatement::Tax::type_? + type: FinchAPI::HRIS::PayStatement::Tax::type_? } class Tax < FinchAPI::Internal::Type::BaseModel attr_accessor amount: Integer? - attr_accessor attributes: FinchAPI::Models::HRIS::PayStatement::Tax::Attributes? + attr_accessor attributes: FinchAPI::HRIS::PayStatement::Tax::Attributes? attr_accessor currency: String? @@ -314,47 +294,41 @@ module FinchAPI attr_accessor name: String? - attr_accessor type: FinchAPI::Models::HRIS::PayStatement::Tax::type_? + attr_accessor type: FinchAPI::HRIS::PayStatement::Tax::type_? def initialize: ( ?amount: Integer?, - ?attributes: FinchAPI::Models::HRIS::PayStatement::Tax::Attributes?, + ?attributes: FinchAPI::HRIS::PayStatement::Tax::Attributes?, ?currency: String?, ?employer: bool?, ?name: String?, - ?type: FinchAPI::Models::HRIS::PayStatement::Tax::type_? + ?type: FinchAPI::HRIS::PayStatement::Tax::type_? ) -> void - def to_hash: -> FinchAPI::Models::HRIS::PayStatement::tax - type attributes = { - metadata: FinchAPI::Models::HRIS::PayStatement::Tax::Attributes::Metadata + metadata: FinchAPI::HRIS::PayStatement::Tax::Attributes::Metadata } class Attributes < FinchAPI::Internal::Type::BaseModel - attr_reader metadata: FinchAPI::Models::HRIS::PayStatement::Tax::Attributes::Metadata? + attr_reader metadata: FinchAPI::HRIS::PayStatement::Tax::Attributes::Metadata? def metadata=: ( - FinchAPI::Models::HRIS::PayStatement::Tax::Attributes::Metadata - ) -> FinchAPI::Models::HRIS::PayStatement::Tax::Attributes::Metadata + FinchAPI::HRIS::PayStatement::Tax::Attributes::Metadata + ) -> FinchAPI::HRIS::PayStatement::Tax::Attributes::Metadata def initialize: ( - ?metadata: FinchAPI::Models::HRIS::PayStatement::Tax::Attributes::Metadata + ?metadata: FinchAPI::HRIS::PayStatement::Tax::Attributes::Metadata ) -> void - def to_hash: -> FinchAPI::Models::HRIS::PayStatement::Tax::attributes - - type metadata = { metadata: ::Hash[Symbol, top] } + type metadata = { metadata: ::Hash[Symbol, top?] } class Metadata < FinchAPI::Internal::Type::BaseModel - attr_reader metadata: ::Hash[Symbol, top]? - - def metadata=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top] + attr_reader metadata: ::Hash[Symbol, top?]? - def initialize: (?metadata: ::Hash[Symbol, top]) -> void + def metadata=: (::Hash[Symbol, top?]) -> ::Hash[Symbol, top?] - def to_hash: -> FinchAPI::Models::HRIS::PayStatement::Tax::Attributes::metadata + def initialize: (?metadata: ::Hash[Symbol, top?]) -> void end end @@ -368,7 +342,7 @@ module FinchAPI LOCAL: :local FICA: :fica - def self?.values: -> ::Array[FinchAPI::Models::HRIS::PayStatement::Tax::type_] + def self?.values: -> ::Array[FinchAPI::HRIS::PayStatement::Tax::type_] end end @@ -381,7 +355,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::HRIS::PayStatement::type_] end end end diff --git a/sig/finch_api/models/hris/pay_statement_response.rbs b/sig/finch_api/models/hris/pay_statement_response.rbs index c16b749e..16a109ce 100644 --- a/sig/finch_api/models/hris/pay_statement_response.rbs +++ b/sig/finch_api/models/hris/pay_statement_response.rbs @@ -3,17 +3,17 @@ module FinchAPI module HRIS type pay_statement_response = { - body: FinchAPI::Models::HRIS::PayStatementResponseBody, + body: FinchAPI::HRIS::PayStatementResponseBody, code: Integer, payment_id: String } class PayStatementResponse < FinchAPI::Internal::Type::BaseModel - attr_reader body: FinchAPI::Models::HRIS::PayStatementResponseBody? + attr_reader body: FinchAPI::HRIS::PayStatementResponseBody? def body=: ( - FinchAPI::Models::HRIS::PayStatementResponseBody - ) -> FinchAPI::Models::HRIS::PayStatementResponseBody + FinchAPI::HRIS::PayStatementResponseBody + ) -> FinchAPI::HRIS::PayStatementResponseBody attr_reader code: Integer? @@ -24,12 +24,10 @@ module FinchAPI def payment_id=: (String) -> String def initialize: ( - ?body: FinchAPI::Models::HRIS::PayStatementResponseBody, + ?body: FinchAPI::HRIS::PayStatementResponseBody, ?code: Integer, ?payment_id: String ) -> void - - def to_hash: -> FinchAPI::Models::HRIS::pay_statement_response end end 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 b23d660b..03b7d292 100644 --- a/sig/finch_api/models/hris/pay_statement_response_body.rbs +++ b/sig/finch_api/models/hris/pay_statement_response_body.rbs @@ -3,27 +3,25 @@ module FinchAPI module HRIS type pay_statement_response_body = { - paging: FinchAPI::Models::Paging, - pay_statements: ::Array[FinchAPI::Models::HRIS::PayStatement] + paging: FinchAPI::Paging, + pay_statements: ::Array[FinchAPI::HRIS::PayStatement] } class PayStatementResponseBody < FinchAPI::Internal::Type::BaseModel - attr_reader paging: FinchAPI::Models::Paging? + attr_reader paging: FinchAPI::Paging? - def paging=: (FinchAPI::Models::Paging) -> FinchAPI::Models::Paging + def paging=: (FinchAPI::Paging) -> FinchAPI::Paging - attr_reader pay_statements: ::Array[FinchAPI::Models::HRIS::PayStatement]? + attr_reader pay_statements: ::Array[FinchAPI::HRIS::PayStatement]? def pay_statements=: ( - ::Array[FinchAPI::Models::HRIS::PayStatement] - ) -> ::Array[FinchAPI::Models::HRIS::PayStatement] + ::Array[FinchAPI::HRIS::PayStatement] + ) -> ::Array[FinchAPI::HRIS::PayStatement] def initialize: ( - ?paging: FinchAPI::Models::Paging, - ?pay_statements: ::Array[FinchAPI::Models::HRIS::PayStatement] + ?paging: FinchAPI::Paging, + ?pay_statements: ::Array[FinchAPI::HRIS::PayStatement] ) -> void - - def to_hash: -> FinchAPI::Models::HRIS::pay_statement_response_body end end 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 a8ed77de..7289e702 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 @@ -3,7 +3,7 @@ module FinchAPI module HRIS type pay_statement_retrieve_many_params = { - requests: ::Array[FinchAPI::Models::HRIS::PayStatementRetrieveManyParams::Request] + requests: ::Array[FinchAPI::HRIS::PayStatementRetrieveManyParams::Request] } & FinchAPI::Internal::Type::request_parameters @@ -11,15 +11,13 @@ module FinchAPI extend FinchAPI::Internal::Type::RequestParameters::Converter include FinchAPI::Internal::Type::RequestParameters - attr_accessor requests: ::Array[FinchAPI::Models::HRIS::PayStatementRetrieveManyParams::Request] + attr_accessor requests: ::Array[FinchAPI::HRIS::PayStatementRetrieveManyParams::Request] def initialize: ( - requests: ::Array[FinchAPI::Models::HRIS::PayStatementRetrieveManyParams::Request], + requests: ::Array[FinchAPI::HRIS::PayStatementRetrieveManyParams::Request], ?request_options: FinchAPI::request_opts ) -> void - def to_hash: -> FinchAPI::Models::HRIS::pay_statement_retrieve_many_params - type request = { payment_id: String, limit: Integer, offset: Integer } class Request < FinchAPI::Internal::Type::BaseModel @@ -38,8 +36,6 @@ module FinchAPI ?limit: Integer, ?offset: Integer ) -> void - - def to_hash: -> FinchAPI::Models::HRIS::PayStatementRetrieveManyParams::request end end end diff --git a/sig/finch_api/models/hris/payment.rbs b/sig/finch_api/models/hris/payment.rbs index b8f3daab..8950479b 100644 --- a/sig/finch_api/models/hris/payment.rbs +++ b/sig/finch_api/models/hris/payment.rbs @@ -4,17 +4,17 @@ module FinchAPI type payment = { id: String, - company_debit: FinchAPI::Models::Money?, + company_debit: FinchAPI::Money?, debit_date: String?, - employee_taxes: FinchAPI::Models::Money?, - employer_taxes: FinchAPI::Models::Money?, - gross_pay: FinchAPI::Models::Money?, + employee_taxes: FinchAPI::Money?, + employer_taxes: FinchAPI::Money?, + gross_pay: FinchAPI::Money?, individual_ids: ::Array[String]?, - net_pay: FinchAPI::Models::Money?, + net_pay: FinchAPI::Money?, pay_date: String?, - pay_frequencies: ::Array[FinchAPI::Models::HRIS::Payment::pay_frequency]?, + pay_frequencies: ::Array[FinchAPI::HRIS::Payment::pay_frequency]?, pay_group_ids: ::Array[String]?, - pay_period: FinchAPI::Models::HRIS::Payment::PayPeriod? + pay_period: FinchAPI::HRIS::Payment::PayPeriod? } class Payment < FinchAPI::Internal::Type::BaseModel @@ -22,45 +22,43 @@ module FinchAPI def id=: (String) -> String - attr_accessor company_debit: FinchAPI::Models::Money? + attr_accessor company_debit: FinchAPI::Money? attr_accessor debit_date: String? - attr_accessor employee_taxes: FinchAPI::Models::Money? + attr_accessor employee_taxes: FinchAPI::Money? - attr_accessor employer_taxes: FinchAPI::Models::Money? + attr_accessor employer_taxes: FinchAPI::Money? - attr_accessor gross_pay: FinchAPI::Models::Money? + attr_accessor gross_pay: FinchAPI::Money? attr_accessor individual_ids: ::Array[String]? - attr_accessor net_pay: FinchAPI::Models::Money? + attr_accessor net_pay: FinchAPI::Money? attr_accessor pay_date: String? - attr_accessor pay_frequencies: ::Array[FinchAPI::Models::HRIS::Payment::pay_frequency]? + attr_accessor pay_frequencies: ::Array[FinchAPI::HRIS::Payment::pay_frequency]? attr_accessor pay_group_ids: ::Array[String]? - attr_accessor pay_period: FinchAPI::Models::HRIS::Payment::PayPeriod? + attr_accessor pay_period: FinchAPI::HRIS::Payment::PayPeriod? def initialize: ( ?id: String, - ?company_debit: FinchAPI::Models::Money?, + ?company_debit: FinchAPI::Money?, ?debit_date: String?, - ?employee_taxes: FinchAPI::Models::Money?, - ?employer_taxes: FinchAPI::Models::Money?, - ?gross_pay: FinchAPI::Models::Money?, + ?employee_taxes: FinchAPI::Money?, + ?employer_taxes: FinchAPI::Money?, + ?gross_pay: FinchAPI::Money?, ?individual_ids: ::Array[String]?, - ?net_pay: FinchAPI::Models::Money?, + ?net_pay: FinchAPI::Money?, ?pay_date: String?, - ?pay_frequencies: ::Array[FinchAPI::Models::HRIS::Payment::pay_frequency]?, + ?pay_frequencies: ::Array[FinchAPI::HRIS::Payment::pay_frequency]?, ?pay_group_ids: ::Array[String]?, - ?pay_period: FinchAPI::Models::HRIS::Payment::PayPeriod? + ?pay_period: FinchAPI::HRIS::Payment::PayPeriod? ) -> void - def to_hash: -> FinchAPI::Models::HRIS::payment - type pay_frequency = :annually | :semi_annually @@ -85,7 +83,7 @@ module FinchAPI DAILY: :daily OTHER: :other - def self?.values: -> ::Array[FinchAPI::Models::HRIS::Payment::pay_frequency] + def self?.values: -> ::Array[FinchAPI::HRIS::Payment::pay_frequency] end type pay_period = { end_date: String?, start_date: String? } @@ -96,8 +94,6 @@ module FinchAPI attr_accessor start_date: String? def initialize: (?end_date: String?, ?start_date: String?) -> void - - def to_hash: -> FinchAPI::Models::HRIS::Payment::pay_period end end end diff --git a/sig/finch_api/models/hris/payment_list_params.rbs b/sig/finch_api/models/hris/payment_list_params.rbs index 40d40f40..41801d09 100644 --- a/sig/finch_api/models/hris/payment_list_params.rbs +++ b/sig/finch_api/models/hris/payment_list_params.rbs @@ -18,8 +18,6 @@ module FinchAPI start_date: Date, ?request_options: FinchAPI::request_opts ) -> void - - def to_hash: -> FinchAPI::Models::HRIS::payment_list_params end end 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 b37cd45a..89374b9b 100644 --- a/sig/finch_api/models/hris/support_per_benefit_type.rbs +++ b/sig/finch_api/models/hris/support_per_benefit_type.rbs @@ -3,29 +3,27 @@ module FinchAPI module HRIS type support_per_benefit_type = { - company_benefits: FinchAPI::Models::OperationSupportMatrix, - individual_benefits: FinchAPI::Models::OperationSupportMatrix + company_benefits: FinchAPI::OperationSupportMatrix, + individual_benefits: FinchAPI::OperationSupportMatrix } class SupportPerBenefitType < FinchAPI::Internal::Type::BaseModel - attr_reader company_benefits: FinchAPI::Models::OperationSupportMatrix? + attr_reader company_benefits: FinchAPI::OperationSupportMatrix? def company_benefits=: ( - FinchAPI::Models::OperationSupportMatrix - ) -> FinchAPI::Models::OperationSupportMatrix + FinchAPI::OperationSupportMatrix + ) -> FinchAPI::OperationSupportMatrix - attr_reader individual_benefits: FinchAPI::Models::OperationSupportMatrix? + attr_reader individual_benefits: FinchAPI::OperationSupportMatrix? def individual_benefits=: ( - FinchAPI::Models::OperationSupportMatrix - ) -> FinchAPI::Models::OperationSupportMatrix + FinchAPI::OperationSupportMatrix + ) -> FinchAPI::OperationSupportMatrix def initialize: ( - ?company_benefits: FinchAPI::Models::OperationSupportMatrix, - ?individual_benefits: FinchAPI::Models::OperationSupportMatrix + ?company_benefits: FinchAPI::OperationSupportMatrix, + ?individual_benefits: FinchAPI::OperationSupportMatrix ) -> void - - def to_hash: -> FinchAPI::Models::HRIS::support_per_benefit_type end end end diff --git a/sig/finch_api/models/hris/supported_benefit.rbs b/sig/finch_api/models/hris/supported_benefit.rbs index d03277f3..04a64638 100644 --- a/sig/finch_api/models/hris/supported_benefit.rbs +++ b/sig/finch_api/models/hris/supported_benefit.rbs @@ -5,11 +5,11 @@ module FinchAPI { annual_maximum: bool?, catch_up: bool?, - company_contribution: ::Array[FinchAPI::Models::HRIS::SupportedBenefit::company_contribution?]?, + company_contribution: ::Array[FinchAPI::HRIS::SupportedBenefit::company_contribution?]?, description: String?, - employee_deduction: ::Array[FinchAPI::Models::HRIS::SupportedBenefit::employee_deduction?]?, + employee_deduction: ::Array[FinchAPI::HRIS::SupportedBenefit::employee_deduction?]?, frequencies: ::Array[FinchAPI::Models::HRIS::benefit_frequency?], - hsa_contribution_limit: ::Array[FinchAPI::Models::HRIS::SupportedBenefit::hsa_contribution_limit?]? + hsa_contribution_limit: ::Array[FinchAPI::HRIS::SupportedBenefit::hsa_contribution_limit?]? } class SupportedBenefit < FinchAPI::Internal::Type::BaseModel @@ -17,11 +17,11 @@ module FinchAPI attr_accessor catch_up: bool? - attr_accessor company_contribution: ::Array[FinchAPI::Models::HRIS::SupportedBenefit::company_contribution?]? + attr_accessor company_contribution: ::Array[FinchAPI::HRIS::SupportedBenefit::company_contribution?]? attr_accessor description: String? - attr_accessor employee_deduction: ::Array[FinchAPI::Models::HRIS::SupportedBenefit::employee_deduction?]? + attr_accessor employee_deduction: ::Array[FinchAPI::HRIS::SupportedBenefit::employee_deduction?]? attr_reader frequencies: ::Array[FinchAPI::Models::HRIS::benefit_frequency?]? @@ -29,20 +29,18 @@ module FinchAPI ::Array[FinchAPI::Models::HRIS::benefit_frequency?] ) -> ::Array[FinchAPI::Models::HRIS::benefit_frequency?] - attr_accessor hsa_contribution_limit: ::Array[FinchAPI::Models::HRIS::SupportedBenefit::hsa_contribution_limit?]? + attr_accessor hsa_contribution_limit: ::Array[FinchAPI::HRIS::SupportedBenefit::hsa_contribution_limit?]? def initialize: ( ?annual_maximum: bool?, ?catch_up: bool?, - ?company_contribution: ::Array[FinchAPI::Models::HRIS::SupportedBenefit::company_contribution?]?, + ?company_contribution: ::Array[FinchAPI::HRIS::SupportedBenefit::company_contribution?]?, ?description: String?, - ?employee_deduction: ::Array[FinchAPI::Models::HRIS::SupportedBenefit::employee_deduction?]?, + ?employee_deduction: ::Array[FinchAPI::HRIS::SupportedBenefit::employee_deduction?]?, ?frequencies: ::Array[FinchAPI::Models::HRIS::benefit_frequency?], - ?hsa_contribution_limit: ::Array[FinchAPI::Models::HRIS::SupportedBenefit::hsa_contribution_limit?]? + ?hsa_contribution_limit: ::Array[FinchAPI::HRIS::SupportedBenefit::hsa_contribution_limit?]? ) -> void - def to_hash: -> FinchAPI::Models::HRIS::supported_benefit - type company_contribution = :fixed | :percent module CompanyContribution @@ -51,7 +49,7 @@ module FinchAPI FIXED: :fixed PERCENT: :percent - def self?.values: -> ::Array[FinchAPI::Models::HRIS::SupportedBenefit::company_contribution] + def self?.values: -> ::Array[FinchAPI::HRIS::SupportedBenefit::company_contribution] end type employee_deduction = :fixed | :percent @@ -62,7 +60,7 @@ module FinchAPI FIXED: :fixed PERCENT: :percent - def self?.values: -> ::Array[FinchAPI::Models::HRIS::SupportedBenefit::employee_deduction] + def self?.values: -> ::Array[FinchAPI::HRIS::SupportedBenefit::employee_deduction] end type hsa_contribution_limit = :individual | :family @@ -73,7 +71,7 @@ module FinchAPI INDIVIDUAL: :individual FAMILY: :family - def self?.values: -> ::Array[FinchAPI::Models::HRIS::SupportedBenefit::hsa_contribution_limit] + def self?.values: -> ::Array[FinchAPI::HRIS::SupportedBenefit::hsa_contribution_limit] end end end 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 761b6897..c0093152 100644 --- a/sig/finch_api/models/hris/update_company_benefit_response.rbs +++ b/sig/finch_api/models/hris/update_company_benefit_response.rbs @@ -10,8 +10,6 @@ module FinchAPI attr_accessor job_id: String def initialize: (benefit_id: String, job_id: String) -> void - - def to_hash: -> FinchAPI::Models::HRIS::update_company_benefit_response end end end diff --git a/sig/finch_api/models/hris/w42005.rbs b/sig/finch_api/models/hris/w42005.rbs index 5986b82e..9c20fc61 100644 --- a/sig/finch_api/models/hris/w42005.rbs +++ b/sig/finch_api/models/hris/w42005.rbs @@ -3,39 +3,37 @@ module FinchAPI module HRIS type w42005 = { - data: FinchAPI::Models::HRIS::W42005::Data, - type: FinchAPI::Models::HRIS::W42005::type_, + data: FinchAPI::HRIS::W42005::Data, + type: FinchAPI::HRIS::W42005::type_, year: Float? } class W42005 < FinchAPI::Internal::Type::BaseModel - attr_reader data: FinchAPI::Models::HRIS::W42005::Data? + attr_reader data: FinchAPI::HRIS::W42005::Data? def data=: ( - FinchAPI::Models::HRIS::W42005::Data - ) -> FinchAPI::Models::HRIS::W42005::Data + FinchAPI::HRIS::W42005::Data + ) -> FinchAPI::HRIS::W42005::Data - attr_reader type: FinchAPI::Models::HRIS::W42005::type_? + attr_reader type: FinchAPI::HRIS::W42005::type_? def type=: ( - FinchAPI::Models::HRIS::W42005::type_ - ) -> FinchAPI::Models::HRIS::W42005::type_ + FinchAPI::HRIS::W42005::type_ + ) -> FinchAPI::HRIS::W42005::type_ attr_accessor year: Float? def initialize: ( - ?data: FinchAPI::Models::HRIS::W42005::Data, - ?type: FinchAPI::Models::HRIS::W42005::type_, + ?data: FinchAPI::HRIS::W42005::Data, + ?type: FinchAPI::HRIS::W42005::type_, ?year: Float? ) -> void - def to_hash: -> FinchAPI::Models::HRIS::w42005 - type data = { additional_withholding: Integer?, - exemption: FinchAPI::Models::HRIS::W42005::Data::exemption, - filing_status: FinchAPI::Models::HRIS::W42005::Data::filing_status?, + exemption: FinchAPI::HRIS::W42005::Data::exemption, + filing_status: FinchAPI::HRIS::W42005::Data::filing_status?, individual_id: String, total_number_of_allowances: Integer? } @@ -43,13 +41,13 @@ module FinchAPI class Data < FinchAPI::Internal::Type::BaseModel attr_accessor additional_withholding: Integer? - attr_reader exemption: FinchAPI::Models::HRIS::W42005::Data::exemption? + attr_reader exemption: FinchAPI::HRIS::W42005::Data::exemption? def exemption=: ( - FinchAPI::Models::HRIS::W42005::Data::exemption - ) -> FinchAPI::Models::HRIS::W42005::Data::exemption + FinchAPI::HRIS::W42005::Data::exemption + ) -> FinchAPI::HRIS::W42005::Data::exemption - attr_accessor filing_status: FinchAPI::Models::HRIS::W42005::Data::filing_status? + attr_accessor filing_status: FinchAPI::HRIS::W42005::Data::filing_status? attr_reader individual_id: String? @@ -59,14 +57,12 @@ module FinchAPI def initialize: ( ?additional_withholding: Integer?, - ?exemption: FinchAPI::Models::HRIS::W42005::Data::exemption, - ?filing_status: FinchAPI::Models::HRIS::W42005::Data::filing_status?, + ?exemption: FinchAPI::HRIS::W42005::Data::exemption, + ?filing_status: FinchAPI::HRIS::W42005::Data::filing_status?, ?individual_id: String, ?total_number_of_allowances: Integer? ) -> void - def to_hash: -> FinchAPI::Models::HRIS::W42005::data - type exemption = :exempt | :non_exempt module Exemption @@ -75,7 +71,7 @@ module FinchAPI EXEMPT: :exempt NON_EXEMPT: :non_exempt - def self?.values: -> ::Array[FinchAPI::Models::HRIS::W42005::Data::exemption] + def self?.values: -> ::Array[FinchAPI::HRIS::W42005::Data::exemption] end type filing_status = @@ -88,7 +84,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::HRIS::W42005::Data::filing_status] end end @@ -99,7 +95,7 @@ module FinchAPI W4_2005: :w4_2005 - def self?.values: -> ::Array[FinchAPI::Models::HRIS::W42005::type_] + def self?.values: -> ::Array[FinchAPI::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 fdee4527..1b4e5367 100644 --- a/sig/finch_api/models/hris/w42020.rbs +++ b/sig/finch_api/models/hris/w42020.rbs @@ -3,41 +3,39 @@ module FinchAPI module HRIS type w42020 = { - data: FinchAPI::Models::HRIS::W42020::Data, - type: FinchAPI::Models::HRIS::W42020::type_, + data: FinchAPI::HRIS::W42020::Data, + type: FinchAPI::HRIS::W42020::type_, year: Float? } class W42020 < FinchAPI::Internal::Type::BaseModel - attr_reader data: FinchAPI::Models::HRIS::W42020::Data? + attr_reader data: FinchAPI::HRIS::W42020::Data? def data=: ( - FinchAPI::Models::HRIS::W42020::Data - ) -> FinchAPI::Models::HRIS::W42020::Data + FinchAPI::HRIS::W42020::Data + ) -> FinchAPI::HRIS::W42020::Data - attr_reader type: FinchAPI::Models::HRIS::W42020::type_? + attr_reader type: FinchAPI::HRIS::W42020::type_? def type=: ( - FinchAPI::Models::HRIS::W42020::type_ - ) -> FinchAPI::Models::HRIS::W42020::type_ + FinchAPI::HRIS::W42020::type_ + ) -> FinchAPI::HRIS::W42020::type_ attr_accessor year: Float? def initialize: ( - ?data: FinchAPI::Models::HRIS::W42020::Data, - ?type: FinchAPI::Models::HRIS::W42020::type_, + ?data: FinchAPI::HRIS::W42020::Data, + ?type: FinchAPI::HRIS::W42020::type_, ?year: Float? ) -> void - def to_hash: -> FinchAPI::Models::HRIS::w42020 - type data = { 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?, + filing_status: FinchAPI::HRIS::W42020::Data::filing_status?, individual_id: String, other_income: Integer?, total_claim_dependent_and_other_credits: Integer? @@ -52,7 +50,7 @@ module FinchAPI attr_accessor extra_withholding: Integer? - attr_accessor filing_status: FinchAPI::Models::HRIS::W42020::Data::filing_status? + attr_accessor filing_status: FinchAPI::HRIS::W42020::Data::filing_status? attr_reader individual_id: String? @@ -67,14 +65,12 @@ module FinchAPI ?amount_for_qualifying_children_under_17: Integer?, ?deductions: Integer?, ?extra_withholding: Integer?, - ?filing_status: FinchAPI::Models::HRIS::W42020::Data::filing_status?, + ?filing_status: FinchAPI::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 - type filing_status = :head_of_household | :married_filing_jointly_or_qualifying_surviving_spouse @@ -87,7 +83,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::HRIS::W42020::Data::filing_status] end end @@ -98,7 +94,7 @@ module FinchAPI W4_2020: :w4_2020 - def self?.values: -> ::Array[FinchAPI::Models::HRIS::W42020::type_] + def self?.values: -> ::Array[FinchAPI::HRIS::W42020::type_] end end end diff --git a/sig/finch_api/models/income.rbs b/sig/finch_api/models/income.rbs index 4a37673e..dcb1e7a1 100644 --- a/sig/finch_api/models/income.rbs +++ b/sig/finch_api/models/income.rbs @@ -5,7 +5,7 @@ module FinchAPI amount: Integer?, currency: String?, effective_date: String?, - unit: FinchAPI::Models::Income::unit? + unit: FinchAPI::Income::unit? } class Income < FinchAPI::Internal::Type::BaseModel @@ -15,17 +15,15 @@ module FinchAPI attr_accessor effective_date: String? - attr_accessor unit: FinchAPI::Models::Income::unit? + attr_accessor unit: FinchAPI::Income::unit? def initialize: ( - ?amount: Integer?, - ?currency: String?, - ?effective_date: String?, - ?unit: FinchAPI::Models::Income::unit? + amount: Integer?, + currency: String?, + effective_date: String?, + unit: FinchAPI::Income::unit? ) -> void - def to_hash: -> FinchAPI::Models::income - type unit = :yearly | :quarterly @@ -50,7 +48,7 @@ module FinchAPI HOURLY: :hourly FIXED: :fixed - def self?.values: -> ::Array[FinchAPI::Models::Income::unit] + def self?.values: -> ::Array[FinchAPI::Income::unit] end end end diff --git a/sig/finch_api/models/individual_event.rbs b/sig/finch_api/models/individual_event.rbs index 960fa5e7..263e53bd 100644 --- a/sig/finch_api/models/individual_event.rbs +++ b/sig/finch_api/models/individual_event.rbs @@ -2,30 +2,28 @@ module FinchAPI module Models type individual_event = { - data: FinchAPI::Models::IndividualEvent::Data, - event_type: FinchAPI::Models::IndividualEvent::event_type + data: FinchAPI::IndividualEvent::Data, + event_type: FinchAPI::IndividualEvent::event_type } class IndividualEvent < FinchAPI::Models::BaseWebhookEvent - def data: -> FinchAPI::Models::IndividualEvent::Data? + def data: -> FinchAPI::IndividualEvent::Data? def data=: ( - FinchAPI::Models::IndividualEvent::Data _ - ) -> FinchAPI::Models::IndividualEvent::Data + FinchAPI::IndividualEvent::Data _ + ) -> FinchAPI::IndividualEvent::Data - def event_type: -> FinchAPI::Models::IndividualEvent::event_type? + def event_type: -> FinchAPI::IndividualEvent::event_type? def event_type=: ( - FinchAPI::Models::IndividualEvent::event_type _ - ) -> FinchAPI::Models::IndividualEvent::event_type + FinchAPI::IndividualEvent::event_type _ + ) -> FinchAPI::IndividualEvent::event_type def initialize: ( - ?data: FinchAPI::Models::IndividualEvent::Data, - ?event_type: FinchAPI::Models::IndividualEvent::event_type + ?data: FinchAPI::IndividualEvent::Data, + ?event_type: FinchAPI::IndividualEvent::event_type ) -> void - def to_hash: -> FinchAPI::Models::individual_event - type data = { individual_id: String } class Data < FinchAPI::Internal::Type::BaseModel @@ -34,8 +32,6 @@ module FinchAPI def individual_id=: (String) -> String def initialize: (?individual_id: String) -> void - - def to_hash: -> FinchAPI::Models::IndividualEvent::data end type event_type = @@ -48,7 +44,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::IndividualEvent::event_type] end end end diff --git a/sig/finch_api/models/introspection.rbs b/sig/finch_api/models/introspection.rbs index d4a00fdc..689c3896 100644 --- a/sig/finch_api/models/introspection.rbs +++ b/sig/finch_api/models/introspection.rbs @@ -4,13 +4,13 @@ module FinchAPI { id: String, account_id: String, - authentication_methods: ::Array[FinchAPI::Models::Introspection::AuthenticationMethod], + authentication_methods: ::Array[FinchAPI::Introspection::AuthenticationMethod], client_id: String, - client_type: FinchAPI::Models::Introspection::client_type, + client_type: FinchAPI::Introspection::client_type, company_id: String, connection_id: String, - connection_status: FinchAPI::Models::Introspection::ConnectionStatus, - connection_type: FinchAPI::Models::Introspection::connection_type, + connection_status: FinchAPI::Introspection::ConnectionStatus, + connection_type: FinchAPI::Introspection::connection_type, customer_email: String?, customer_id: String?, customer_name: String?, @@ -26,19 +26,19 @@ module FinchAPI attr_accessor account_id: String - attr_accessor authentication_methods: ::Array[FinchAPI::Models::Introspection::AuthenticationMethod] + attr_accessor authentication_methods: ::Array[FinchAPI::Introspection::AuthenticationMethod] attr_accessor client_id: String - attr_accessor client_type: FinchAPI::Models::Introspection::client_type + attr_accessor client_type: FinchAPI::Introspection::client_type attr_accessor company_id: String attr_accessor connection_id: String - attr_accessor connection_status: FinchAPI::Models::Introspection::ConnectionStatus + attr_accessor connection_status: FinchAPI::Introspection::ConnectionStatus - attr_accessor connection_type: FinchAPI::Models::Introspection::connection_type + attr_accessor connection_type: FinchAPI::Introspection::connection_type attr_accessor customer_email: String? @@ -59,13 +59,13 @@ module FinchAPI def initialize: ( id: String, account_id: String, - authentication_methods: ::Array[FinchAPI::Models::Introspection::AuthenticationMethod], + authentication_methods: ::Array[FinchAPI::Introspection::AuthenticationMethod], client_id: String, - client_type: FinchAPI::Models::Introspection::client_type, + client_type: FinchAPI::Introspection::client_type, company_id: String, connection_id: String, - connection_status: FinchAPI::Models::Introspection::ConnectionStatus, - connection_type: FinchAPI::Models::Introspection::connection_type, + connection_status: FinchAPI::Introspection::ConnectionStatus, + connection_type: FinchAPI::Introspection::connection_type, customer_email: String?, customer_id: String?, customer_name: String?, @@ -76,40 +76,36 @@ module FinchAPI username: String ) -> void - def to_hash: -> FinchAPI::Models::introspection - type authentication_method = { - connection_status: FinchAPI::Models::Introspection::AuthenticationMethod::ConnectionStatus, + connection_status: FinchAPI::Introspection::AuthenticationMethod::ConnectionStatus, products: ::Array[String], - type: FinchAPI::Models::Introspection::AuthenticationMethod::type_ + type: FinchAPI::Introspection::AuthenticationMethod::type_ } class AuthenticationMethod < FinchAPI::Internal::Type::BaseModel - attr_reader connection_status: FinchAPI::Models::Introspection::AuthenticationMethod::ConnectionStatus? + attr_reader connection_status: FinchAPI::Introspection::AuthenticationMethod::ConnectionStatus? def connection_status=: ( - FinchAPI::Models::Introspection::AuthenticationMethod::ConnectionStatus - ) -> FinchAPI::Models::Introspection::AuthenticationMethod::ConnectionStatus + FinchAPI::Introspection::AuthenticationMethod::ConnectionStatus + ) -> FinchAPI::Introspection::AuthenticationMethod::ConnectionStatus attr_reader products: ::Array[String]? def products=: (::Array[String]) -> ::Array[String] - attr_reader type: FinchAPI::Models::Introspection::AuthenticationMethod::type_? + attr_reader type: FinchAPI::Introspection::AuthenticationMethod::type_? def type=: ( - FinchAPI::Models::Introspection::AuthenticationMethod::type_ - ) -> FinchAPI::Models::Introspection::AuthenticationMethod::type_ + FinchAPI::Introspection::AuthenticationMethod::type_ + ) -> FinchAPI::Introspection::AuthenticationMethod::type_ def initialize: ( - ?connection_status: FinchAPI::Models::Introspection::AuthenticationMethod::ConnectionStatus, + ?connection_status: FinchAPI::Introspection::AuthenticationMethod::ConnectionStatus, ?products: ::Array[String], - ?type: FinchAPI::Models::Introspection::AuthenticationMethod::type_ + ?type: FinchAPI::Introspection::AuthenticationMethod::type_ ) -> void - def to_hash: -> FinchAPI::Models::Introspection::authentication_method - type connection_status = { message: String, status: FinchAPI::Models::connection_status_type } @@ -128,8 +124,6 @@ module FinchAPI ?message: String, ?status: FinchAPI::Models::connection_status_type ) -> void - - def to_hash: -> FinchAPI::Models::Introspection::AuthenticationMethod::connection_status end type type_ = @@ -144,7 +138,7 @@ module FinchAPI API_CREDENTIAL: :api_credential OAUTH: :oauth - def self?.values: -> ::Array[FinchAPI::Models::Introspection::AuthenticationMethod::type_] + def self?.values: -> ::Array[FinchAPI::Introspection::AuthenticationMethod::type_] end end @@ -157,7 +151,7 @@ module FinchAPI DEVELOPMENT: :development SANDBOX: :sandbox - def self?.values: -> ::Array[FinchAPI::Models::Introspection::client_type] + def self?.values: -> ::Array[FinchAPI::Introspection::client_type] end type connection_status = @@ -187,8 +181,6 @@ module FinchAPI ?message: String, ?status: FinchAPI::Models::connection_status_type ) -> void - - def to_hash: -> FinchAPI::Models::Introspection::connection_status end type connection_type = :provider | :finch @@ -199,7 +191,7 @@ module FinchAPI PROVIDER: :provider FINCH: :finch - def self?.values: -> ::Array[FinchAPI::Models::Introspection::connection_type] + def self?.values: -> ::Array[FinchAPI::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 a2c11d87..f6870887 100644 --- a/sig/finch_api/models/job_completion_event.rbs +++ b/sig/finch_api/models/job_completion_event.rbs @@ -2,30 +2,28 @@ module FinchAPI module Models type job_completion_event = { - data: FinchAPI::Models::JobCompletionEvent::Data, - event_type: FinchAPI::Models::JobCompletionEvent::event_type + data: FinchAPI::JobCompletionEvent::Data, + event_type: FinchAPI::JobCompletionEvent::event_type } class JobCompletionEvent < FinchAPI::Models::BaseWebhookEvent - def data: -> FinchAPI::Models::JobCompletionEvent::Data? + def data: -> FinchAPI::JobCompletionEvent::Data? def data=: ( - FinchAPI::Models::JobCompletionEvent::Data _ - ) -> FinchAPI::Models::JobCompletionEvent::Data + FinchAPI::JobCompletionEvent::Data _ + ) -> FinchAPI::JobCompletionEvent::Data - def event_type: -> FinchAPI::Models::JobCompletionEvent::event_type? + def event_type: -> FinchAPI::JobCompletionEvent::event_type? def event_type=: ( - FinchAPI::Models::JobCompletionEvent::event_type _ - ) -> FinchAPI::Models::JobCompletionEvent::event_type + FinchAPI::JobCompletionEvent::event_type _ + ) -> FinchAPI::JobCompletionEvent::event_type def initialize: ( - ?data: FinchAPI::Models::JobCompletionEvent::Data, - ?event_type: FinchAPI::Models::JobCompletionEvent::event_type + ?data: FinchAPI::JobCompletionEvent::Data, + ?event_type: FinchAPI::JobCompletionEvent::event_type ) -> void - def to_hash: -> FinchAPI::Models::job_completion_event - type data = { job_id: String, job_url: String } class Data < FinchAPI::Internal::Type::BaseModel @@ -34,8 +32,6 @@ module FinchAPI attr_accessor job_url: String def initialize: (job_id: String, job_url: String) -> void - - def to_hash: -> FinchAPI::Models::JobCompletionEvent::data end type event_type = @@ -56,7 +52,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::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 712380da..3290f7a1 100644 --- a/sig/finch_api/models/jobs/automated_async_job.rbs +++ b/sig/finch_api/models/jobs/automated_async_job.rbs @@ -7,11 +7,11 @@ module FinchAPI created_at: Time, job_id: String, job_url: String, - params: FinchAPI::Models::Jobs::AutomatedAsyncJob::Params?, + params: FinchAPI::Jobs::AutomatedAsyncJob::Params?, scheduled_at: Time?, started_at: Time?, - status: FinchAPI::Models::Jobs::AutomatedAsyncJob::status, - type: FinchAPI::Models::Jobs::AutomatedAsyncJob::type_ + status: FinchAPI::Jobs::AutomatedAsyncJob::status, + type: FinchAPI::Jobs::AutomatedAsyncJob::type_ } class AutomatedAsyncJob < FinchAPI::Internal::Type::BaseModel @@ -23,30 +23,28 @@ module FinchAPI attr_accessor job_url: String - attr_accessor params: FinchAPI::Models::Jobs::AutomatedAsyncJob::Params? + attr_accessor params: FinchAPI::Jobs::AutomatedAsyncJob::Params? attr_accessor scheduled_at: Time? attr_accessor started_at: Time? - attr_accessor status: FinchAPI::Models::Jobs::AutomatedAsyncJob::status + attr_accessor status: FinchAPI::Jobs::AutomatedAsyncJob::status - attr_accessor type: FinchAPI::Models::Jobs::AutomatedAsyncJob::type_ + attr_accessor type: FinchAPI::Jobs::AutomatedAsyncJob::type_ def initialize: ( completed_at: Time?, created_at: Time, job_id: String, job_url: String, - params: FinchAPI::Models::Jobs::AutomatedAsyncJob::Params?, + params: FinchAPI::Jobs::AutomatedAsyncJob::Params?, scheduled_at: Time?, started_at: Time?, - status: FinchAPI::Models::Jobs::AutomatedAsyncJob::status, - type: FinchAPI::Models::Jobs::AutomatedAsyncJob::type_ + status: FinchAPI::Jobs::AutomatedAsyncJob::status, + type: FinchAPI::Jobs::AutomatedAsyncJob::type_ ) -> void - def to_hash: -> FinchAPI::Models::Jobs::automated_async_job - type params = { individual_id: String } class Params < FinchAPI::Internal::Type::BaseModel @@ -55,8 +53,6 @@ module FinchAPI def individual_id=: (String) -> String def initialize: (?individual_id: String) -> void - - def to_hash: -> FinchAPI::Models::Jobs::AutomatedAsyncJob::params end type status = @@ -77,7 +73,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::Jobs::AutomatedAsyncJob::status] end type type_ = :data_sync_all | :w4_form_employee_sync @@ -88,7 +84,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::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 632d3379..ae78c312 100644 --- a/sig/finch_api/models/jobs/automated_create_params.rbs +++ b/sig/finch_api/models/jobs/automated_create_params.rbs @@ -4,7 +4,7 @@ module FinchAPI type automated_create_params = { type: FinchAPI::Models::Jobs::AutomatedCreateParams::type_, - params: FinchAPI::Models::Jobs::AutomatedCreateParams::Params + params: FinchAPI::Jobs::AutomatedCreateParams::Params } & FinchAPI::Internal::Type::request_parameters @@ -14,16 +14,14 @@ module FinchAPI attr_accessor type: FinchAPI::Models::Jobs::AutomatedCreateParams::type_ - attr_accessor params: FinchAPI::Models::Jobs::AutomatedCreateParams::Params + attr_accessor params: FinchAPI::Jobs::AutomatedCreateParams::Params def initialize: ( type: FinchAPI::Models::Jobs::AutomatedCreateParams::type_, - params: FinchAPI::Models::Jobs::AutomatedCreateParams::Params, + params: FinchAPI::Jobs::AutomatedCreateParams::Params, ?request_options: FinchAPI::request_opts ) -> void - def to_hash: -> FinchAPI::Models::Jobs::automated_create_params - type type_ = :w4_form_employee_sync module Type @@ -40,8 +38,6 @@ module FinchAPI attr_accessor individual_id: String def initialize: (individual_id: String) -> void - - def to_hash: -> FinchAPI::Models::Jobs::AutomatedCreateParams::params end end end diff --git a/sig/finch_api/models/jobs/automated_create_response.rbs b/sig/finch_api/models/jobs/automated_create_response.rbs index 41e05bac..725ab982 100644 --- a/sig/finch_api/models/jobs/automated_create_response.rbs +++ b/sig/finch_api/models/jobs/automated_create_response.rbs @@ -24,8 +24,6 @@ module FinchAPI job_url: String, remaining_refreshes: Integer ) -> void - - def to_hash: -> FinchAPI::Models::Jobs::automated_create_response end end end diff --git a/sig/finch_api/models/jobs/automated_list_params.rbs b/sig/finch_api/models/jobs/automated_list_params.rbs index 0fa571c1..8e38d3e7 100644 --- a/sig/finch_api/models/jobs/automated_list_params.rbs +++ b/sig/finch_api/models/jobs/automated_list_params.rbs @@ -22,8 +22,6 @@ module FinchAPI ?offset: Integer, ?request_options: FinchAPI::request_opts ) -> void - - def to_hash: -> FinchAPI::Models::Jobs::automated_list_params end end end diff --git a/sig/finch_api/models/jobs/automated_list_response.rbs b/sig/finch_api/models/jobs/automated_list_response.rbs index aadd8fea..9d419192 100644 --- a/sig/finch_api/models/jobs/automated_list_response.rbs +++ b/sig/finch_api/models/jobs/automated_list_response.rbs @@ -3,22 +3,20 @@ module FinchAPI module Jobs type automated_list_response = { - data: ::Array[FinchAPI::Models::Jobs::AutomatedAsyncJob], + data: ::Array[FinchAPI::Jobs::AutomatedAsyncJob], meta: FinchAPI::Models::Jobs::AutomatedListResponse::Meta } class AutomatedListResponse < FinchAPI::Internal::Type::BaseModel - attr_accessor data: ::Array[FinchAPI::Models::Jobs::AutomatedAsyncJob] + attr_accessor data: ::Array[FinchAPI::Jobs::AutomatedAsyncJob] attr_accessor meta: FinchAPI::Models::Jobs::AutomatedListResponse::Meta def initialize: ( - data: ::Array[FinchAPI::Models::Jobs::AutomatedAsyncJob], + data: ::Array[FinchAPI::Jobs::AutomatedAsyncJob], meta: FinchAPI::Models::Jobs::AutomatedListResponse::Meta ) -> void - def to_hash: -> FinchAPI::Models::Jobs::automated_list_response - type meta = { quotas: FinchAPI::Models::Jobs::AutomatedListResponse::Meta::Quotas @@ -35,8 +33,6 @@ module FinchAPI ?quotas: FinchAPI::Models::Jobs::AutomatedListResponse::Meta::Quotas ) -> void - def to_hash: -> FinchAPI::Models::Jobs::AutomatedListResponse::meta - type quotas = { data_sync_all: FinchAPI::Models::Jobs::AutomatedListResponse::Meta::Quotas::DataSyncAll @@ -53,8 +49,6 @@ module FinchAPI ?data_sync_all: FinchAPI::Models::Jobs::AutomatedListResponse::Meta::Quotas::DataSyncAll ) -> void - def to_hash: -> FinchAPI::Models::Jobs::AutomatedListResponse::Meta::quotas - type data_sync_all = { allowed_refreshes: Integer, remaining_refreshes: Integer } @@ -71,8 +65,6 @@ module FinchAPI ?allowed_refreshes: Integer, ?remaining_refreshes: Integer ) -> void - - def to_hash: -> FinchAPI::Models::Jobs::AutomatedListResponse::Meta::Quotas::data_sync_all end end end diff --git a/sig/finch_api/models/jobs/automated_retrieve_params.rbs b/sig/finch_api/models/jobs/automated_retrieve_params.rbs index 6b3ffe2f..50ca0a28 100644 --- a/sig/finch_api/models/jobs/automated_retrieve_params.rbs +++ b/sig/finch_api/models/jobs/automated_retrieve_params.rbs @@ -9,8 +9,6 @@ module FinchAPI include FinchAPI::Internal::Type::RequestParameters def initialize: (?request_options: FinchAPI::request_opts) -> void - - def to_hash: -> FinchAPI::Models::Jobs::automated_retrieve_params end end end diff --git a/sig/finch_api/models/jobs/manual_async_job.rbs b/sig/finch_api/models/jobs/manual_async_job.rbs index af87acbb..4691897c 100644 --- a/sig/finch_api/models/jobs/manual_async_job.rbs +++ b/sig/finch_api/models/jobs/manual_async_job.rbs @@ -5,7 +5,7 @@ module FinchAPI { body: ::Array[top]?, job_id: String, - status: FinchAPI::Models::Jobs::ManualAsyncJob::status + status: FinchAPI::Jobs::ManualAsyncJob::status } class ManualAsyncJob < FinchAPI::Internal::Type::BaseModel @@ -13,16 +13,14 @@ module FinchAPI attr_accessor job_id: String - attr_accessor status: FinchAPI::Models::Jobs::ManualAsyncJob::status + attr_accessor status: FinchAPI::Jobs::ManualAsyncJob::status def initialize: ( body: ::Array[top]?, job_id: String, - status: FinchAPI::Models::Jobs::ManualAsyncJob::status + status: FinchAPI::Jobs::ManualAsyncJob::status ) -> void - def to_hash: -> FinchAPI::Models::Jobs::manual_async_job - type status = :pending | :in_progress | :error | :complete module Status @@ -33,7 +31,7 @@ module FinchAPI ERROR: :error COMPLETE: :complete - def self?.values: -> ::Array[FinchAPI::Models::Jobs::ManualAsyncJob::status] + def self?.values: -> ::Array[FinchAPI::Jobs::ManualAsyncJob::status] end end end diff --git a/sig/finch_api/models/jobs/manual_retrieve_params.rbs b/sig/finch_api/models/jobs/manual_retrieve_params.rbs index 1b6b6c08..26afd780 100644 --- a/sig/finch_api/models/jobs/manual_retrieve_params.rbs +++ b/sig/finch_api/models/jobs/manual_retrieve_params.rbs @@ -9,8 +9,6 @@ module FinchAPI include FinchAPI::Internal::Type::RequestParameters def initialize: (?request_options: FinchAPI::request_opts) -> void - - def to_hash: -> FinchAPI::Models::Jobs::manual_retrieve_params end end end diff --git a/sig/finch_api/models/location.rbs b/sig/finch_api/models/location.rbs index 79f676da..10f866f5 100644 --- a/sig/finch_api/models/location.rbs +++ b/sig/finch_api/models/location.rbs @@ -39,8 +39,6 @@ module FinchAPI ?name: String?, ?source_id: String? ) -> void - - def to_hash: -> FinchAPI::Models::location end end end diff --git a/sig/finch_api/models/money.rbs b/sig/finch_api/models/money.rbs index 0a741e41..31fc9398 100644 --- a/sig/finch_api/models/money.rbs +++ b/sig/finch_api/models/money.rbs @@ -10,8 +10,6 @@ module FinchAPI def currency=: (String) -> String def initialize: (?amount: Integer?, ?currency: String) -> void - - def to_hash: -> FinchAPI::Models::money end end end diff --git a/sig/finch_api/models/operation_support_matrix.rbs b/sig/finch_api/models/operation_support_matrix.rbs index 0f81de44..9083fd8d 100644 --- a/sig/finch_api/models/operation_support_matrix.rbs +++ b/sig/finch_api/models/operation_support_matrix.rbs @@ -39,8 +39,6 @@ module FinchAPI ?read: FinchAPI::Models::operation_support, ?update: FinchAPI::Models::operation_support ) -> void - - def to_hash: -> FinchAPI::Models::operation_support_matrix end end end diff --git a/sig/finch_api/models/paging.rbs b/sig/finch_api/models/paging.rbs index b3a15999..49803a1b 100644 --- a/sig/finch_api/models/paging.rbs +++ b/sig/finch_api/models/paging.rbs @@ -10,8 +10,6 @@ module FinchAPI def count=: (Integer) -> Integer def initialize: (offset: Integer, ?count: Integer) -> void - - def to_hash: -> FinchAPI::Models::paging end end end diff --git a/sig/finch_api/models/pay_statement_event.rbs b/sig/finch_api/models/pay_statement_event.rbs index 3216a869..7ebadee2 100644 --- a/sig/finch_api/models/pay_statement_event.rbs +++ b/sig/finch_api/models/pay_statement_event.rbs @@ -2,30 +2,28 @@ module FinchAPI module Models type pay_statement_event = { - data: FinchAPI::Models::PayStatementEvent::Data, - event_type: FinchAPI::Models::PayStatementEvent::event_type + data: FinchAPI::PayStatementEvent::Data, + event_type: FinchAPI::PayStatementEvent::event_type } class PayStatementEvent < FinchAPI::Models::BaseWebhookEvent - def data: -> FinchAPI::Models::PayStatementEvent::Data? + def data: -> FinchAPI::PayStatementEvent::Data? def data=: ( - FinchAPI::Models::PayStatementEvent::Data _ - ) -> FinchAPI::Models::PayStatementEvent::Data + FinchAPI::PayStatementEvent::Data _ + ) -> FinchAPI::PayStatementEvent::Data - def event_type: -> FinchAPI::Models::PayStatementEvent::event_type? + def event_type: -> FinchAPI::PayStatementEvent::event_type? def event_type=: ( - FinchAPI::Models::PayStatementEvent::event_type _ - ) -> FinchAPI::Models::PayStatementEvent::event_type + FinchAPI::PayStatementEvent::event_type _ + ) -> FinchAPI::PayStatementEvent::event_type def initialize: ( - ?data: FinchAPI::Models::PayStatementEvent::Data, - ?event_type: FinchAPI::Models::PayStatementEvent::event_type + ?data: FinchAPI::PayStatementEvent::Data, + ?event_type: FinchAPI::PayStatementEvent::event_type ) -> void - def to_hash: -> FinchAPI::Models::pay_statement_event - type data = { individual_id: String, payment_id: String } class Data < FinchAPI::Internal::Type::BaseModel @@ -38,8 +36,6 @@ module FinchAPI def payment_id=: (String) -> String def initialize: (?individual_id: String, ?payment_id: String) -> void - - def to_hash: -> FinchAPI::Models::PayStatementEvent::data end type event_type = @@ -54,7 +50,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::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 999abc8b..ddef02a6 100644 --- a/sig/finch_api/models/payment_event.rbs +++ b/sig/finch_api/models/payment_event.rbs @@ -2,30 +2,28 @@ module FinchAPI module Models type payment_event = { - data: FinchAPI::Models::PaymentEvent::Data, - event_type: FinchAPI::Models::PaymentEvent::event_type + data: FinchAPI::PaymentEvent::Data, + event_type: FinchAPI::PaymentEvent::event_type } class PaymentEvent < FinchAPI::Models::BaseWebhookEvent - def data: -> FinchAPI::Models::PaymentEvent::Data? + def data: -> FinchAPI::PaymentEvent::Data? def data=: ( - FinchAPI::Models::PaymentEvent::Data _ - ) -> FinchAPI::Models::PaymentEvent::Data + FinchAPI::PaymentEvent::Data _ + ) -> FinchAPI::PaymentEvent::Data - def event_type: -> FinchAPI::Models::PaymentEvent::event_type? + def event_type: -> FinchAPI::PaymentEvent::event_type? def event_type=: ( - FinchAPI::Models::PaymentEvent::event_type _ - ) -> FinchAPI::Models::PaymentEvent::event_type + FinchAPI::PaymentEvent::event_type _ + ) -> FinchAPI::PaymentEvent::event_type def initialize: ( - ?data: FinchAPI::Models::PaymentEvent::Data, - ?event_type: FinchAPI::Models::PaymentEvent::event_type + ?data: FinchAPI::PaymentEvent::Data, + ?event_type: FinchAPI::PaymentEvent::event_type ) -> void - def to_hash: -> FinchAPI::Models::payment_event - type data = { pay_date: String, payment_id: String } class Data < FinchAPI::Internal::Type::BaseModel @@ -34,8 +32,6 @@ module FinchAPI attr_accessor payment_id: String def initialize: (pay_date: String, payment_id: String) -> void - - def to_hash: -> FinchAPI::Models::PaymentEvent::data end type event_type = @@ -48,7 +44,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::PaymentEvent::event_type] end end 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 3d0c94e4..6aa11f86 100644 --- a/sig/finch_api/models/payroll/pay_group_list_params.rbs +++ b/sig/finch_api/models/payroll/pay_group_list_params.rbs @@ -22,8 +22,6 @@ module FinchAPI ?pay_frequencies: ::Array[String], ?request_options: FinchAPI::request_opts ) -> void - - def to_hash: -> FinchAPI::Models::Payroll::pay_group_list_params 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 df9378e7..9b203674 100644 --- a/sig/finch_api/models/payroll/pay_group_list_response.rbs +++ b/sig/finch_api/models/payroll/pay_group_list_response.rbs @@ -29,8 +29,6 @@ module FinchAPI ?pay_frequencies: ::Array[FinchAPI::Models::Payroll::PayGroupListResponse::pay_frequency] ) -> void - def to_hash: -> FinchAPI::Models::Payroll::pay_group_list_response - type pay_frequency = :annually | :semi_annually 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 915ce055..d901447d 100644 --- a/sig/finch_api/models/payroll/pay_group_retrieve_params.rbs +++ b/sig/finch_api/models/payroll/pay_group_retrieve_params.rbs @@ -9,8 +9,6 @@ module FinchAPI include FinchAPI::Internal::Type::RequestParameters def initialize: (?request_options: FinchAPI::request_opts) -> void - - def to_hash: -> FinchAPI::Models::Payroll::pay_group_retrieve_params 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 c4544a3d..4fbffd0b 100644 --- a/sig/finch_api/models/payroll/pay_group_retrieve_response.rbs +++ b/sig/finch_api/models/payroll/pay_group_retrieve_response.rbs @@ -25,8 +25,6 @@ module FinchAPI pay_frequencies: ::Array[FinchAPI::Models::Payroll::PayGroupRetrieveResponse::pay_frequency] ) -> void - def to_hash: -> FinchAPI::Models::Payroll::pay_group_retrieve_response - type pay_frequency = :annually | :semi_annually diff --git a/sig/finch_api/models/provider.rbs b/sig/finch_api/models/provider.rbs index 026e696a..3a9f2f9a 100644 --- a/sig/finch_api/models/provider.rbs +++ b/sig/finch_api/models/provider.rbs @@ -3,7 +3,7 @@ module FinchAPI type provider = { id: String, - authentication_methods: ::Array[FinchAPI::Models::Provider::AuthenticationMethod], + authentication_methods: ::Array[FinchAPI::Provider::AuthenticationMethod], beta: bool, display_name: String, icon: String, @@ -19,11 +19,11 @@ module FinchAPI def id=: (String) -> String - attr_reader authentication_methods: ::Array[FinchAPI::Models::Provider::AuthenticationMethod]? + attr_reader authentication_methods: ::Array[FinchAPI::Provider::AuthenticationMethod]? def authentication_methods=: ( - ::Array[FinchAPI::Models::Provider::AuthenticationMethod] - ) -> ::Array[FinchAPI::Models::Provider::AuthenticationMethod] + ::Array[FinchAPI::Provider::AuthenticationMethod] + ) -> ::Array[FinchAPI::Provider::AuthenticationMethod] attr_reader beta: bool? @@ -59,7 +59,7 @@ module FinchAPI def initialize: ( ?id: String, - ?authentication_methods: ::Array[FinchAPI::Models::Provider::AuthenticationMethod], + ?authentication_methods: ::Array[FinchAPI::Provider::AuthenticationMethod], ?beta: bool, ?display_name: String, ?icon: String, @@ -70,109 +70,103 @@ module FinchAPI ?products: ::Array[String] ) -> void - def to_hash: -> FinchAPI::Models::provider - type authentication_method = { - benefits_support: FinchAPI::Models::HRIS::BenefitsSupport?, - supported_fields: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields?, - type: FinchAPI::Models::Provider::AuthenticationMethod::type_ + benefits_support: FinchAPI::HRIS::BenefitsSupport?, + supported_fields: FinchAPI::Provider::AuthenticationMethod::SupportedFields?, + type: FinchAPI::Provider::AuthenticationMethod::type_ } class AuthenticationMethod < FinchAPI::Internal::Type::BaseModel - attr_accessor benefits_support: FinchAPI::Models::HRIS::BenefitsSupport? + attr_accessor benefits_support: FinchAPI::HRIS::BenefitsSupport? - attr_accessor supported_fields: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields? + attr_accessor supported_fields: FinchAPI::Provider::AuthenticationMethod::SupportedFields? - attr_reader type: FinchAPI::Models::Provider::AuthenticationMethod::type_? + attr_reader type: FinchAPI::Provider::AuthenticationMethod::type_? def type=: ( - FinchAPI::Models::Provider::AuthenticationMethod::type_ - ) -> FinchAPI::Models::Provider::AuthenticationMethod::type_ + FinchAPI::Provider::AuthenticationMethod::type_ + ) -> FinchAPI::Provider::AuthenticationMethod::type_ def initialize: ( - ?benefits_support: FinchAPI::Models::HRIS::BenefitsSupport?, - ?supported_fields: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields?, - ?type: FinchAPI::Models::Provider::AuthenticationMethod::type_ + ?benefits_support: FinchAPI::HRIS::BenefitsSupport?, + ?supported_fields: FinchAPI::Provider::AuthenticationMethod::SupportedFields?, + ?type: FinchAPI::Provider::AuthenticationMethod::type_ ) -> void - def to_hash: -> FinchAPI::Models::Provider::authentication_method - type supported_fields = { - 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::Provider::AuthenticationMethod::SupportedFields::Company, + directory: FinchAPI::Provider::AuthenticationMethod::SupportedFields::Directory, + employment: FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment, + individual: FinchAPI::Provider::AuthenticationMethod::SupportedFields::Individual, + pay_group: FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayGroup, + pay_statement: FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement, + payment: FinchAPI::Provider::AuthenticationMethod::SupportedFields::Payment } class SupportedFields < FinchAPI::Internal::Type::BaseModel - attr_reader company: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company? + attr_reader company: FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company? def company=: ( - FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company - ) -> FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company + FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company + ) -> FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company - attr_reader directory: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Directory? + attr_reader directory: FinchAPI::Provider::AuthenticationMethod::SupportedFields::Directory? def directory=: ( - FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Directory - ) -> FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Directory + FinchAPI::Provider::AuthenticationMethod::SupportedFields::Directory + ) -> FinchAPI::Provider::AuthenticationMethod::SupportedFields::Directory - attr_reader employment: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment? + attr_reader employment: FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment? def employment=: ( - FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment - ) -> FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment + FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment + ) -> FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment - attr_reader individual: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Individual? + attr_reader individual: FinchAPI::Provider::AuthenticationMethod::SupportedFields::Individual? def individual=: ( - FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Individual - ) -> FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Individual + FinchAPI::Provider::AuthenticationMethod::SupportedFields::Individual + ) -> FinchAPI::Provider::AuthenticationMethod::SupportedFields::Individual - attr_reader pay_group: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayGroup? + attr_reader pay_group: FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayGroup? def pay_group=: ( - FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayGroup - ) -> FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayGroup + FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayGroup + ) -> FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayGroup - attr_reader pay_statement: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement? + attr_reader pay_statement: FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement? def pay_statement=: ( - FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement - ) -> FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement + FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement + ) -> FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement - attr_reader payment: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Payment? + attr_reader payment: FinchAPI::Provider::AuthenticationMethod::SupportedFields::Payment? def payment=: ( - FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Payment - ) -> FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Payment + FinchAPI::Provider::AuthenticationMethod::SupportedFields::Payment + ) -> FinchAPI::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 + ?company: FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company, + ?directory: FinchAPI::Provider::AuthenticationMethod::SupportedFields::Directory, + ?employment: FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment, + ?individual: FinchAPI::Provider::AuthenticationMethod::SupportedFields::Individual, + ?pay_group: FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayGroup, + ?pay_statement: FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement, + ?payment: FinchAPI::Provider::AuthenticationMethod::SupportedFields::Payment ) -> void - def to_hash: -> FinchAPI::Models::Provider::AuthenticationMethod::supported_fields - type company = { id: bool, - accounts: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Accounts, - departments: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Departments, + accounts: FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company::Accounts, + departments: FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company::Departments, ein: bool, - entity: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Entity, + entity: FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company::Entity, legal_name: bool, - locations: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Locations, + locations: FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company::Locations, primary_email: bool, primary_phone_number: bool } @@ -182,37 +176,37 @@ module FinchAPI def id=: (bool) -> bool - attr_reader accounts: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Accounts? + attr_reader accounts: FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company::Accounts? def accounts=: ( - FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Accounts - ) -> FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Accounts + FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company::Accounts + ) -> FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company::Accounts - attr_reader departments: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Departments? + attr_reader departments: FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company::Departments? def departments=: ( - FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Departments - ) -> FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Departments + FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company::Departments + ) -> FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company::Departments attr_reader ein: bool? def ein=: (bool) -> bool - attr_reader entity: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Entity? + attr_reader entity: FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company::Entity? def entity=: ( - FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Entity - ) -> FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Entity + FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company::Entity + ) -> FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company::Entity attr_reader legal_name: bool? def legal_name=: (bool) -> bool - attr_reader locations: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Locations? + attr_reader locations: FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company::Locations? def locations=: ( - FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Locations - ) -> FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Locations + FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company::Locations + ) -> FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company::Locations attr_reader primary_email: bool? @@ -224,18 +218,16 @@ module FinchAPI def initialize: ( ?id: bool, - ?accounts: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Accounts, - ?departments: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Departments, + ?accounts: FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company::Accounts, + ?departments: FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company::Departments, ?ein: bool, - ?entity: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Entity, + ?entity: FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company::Entity, ?legal_name: bool, - ?locations: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Locations, + ?locations: FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company::Locations, ?primary_email: bool, ?primary_phone_number: bool ) -> void - def to_hash: -> FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::company - type accounts = { account_name: bool, @@ -273,14 +265,12 @@ module FinchAPI ?institution_name: bool, ?routing_number: bool ) -> void - - def to_hash: -> FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::accounts end type departments = { name: bool, - parent: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Departments::Parent + parent: FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company::Departments::Parent } class Departments < FinchAPI::Internal::Type::BaseModel @@ -288,19 +278,17 @@ module FinchAPI def name=: (bool) -> bool - attr_reader parent: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Departments::Parent? + attr_reader parent: FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company::Departments::Parent? def parent=: ( - FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Departments::Parent - ) -> FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Departments::Parent + FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company::Departments::Parent + ) -> FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company::Departments::Parent def initialize: ( ?name: bool, - ?parent: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Departments::Parent + ?parent: FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company::Departments::Parent ) -> void - def to_hash: -> FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::departments - type parent = { name: bool } class Parent < FinchAPI::Internal::Type::BaseModel @@ -309,8 +297,6 @@ module FinchAPI def name=: (bool) -> bool def initialize: (?name: bool) -> void - - def to_hash: -> FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Departments::parent end end @@ -326,8 +312,6 @@ module FinchAPI def type=: (bool) -> bool def initialize: (?subtype: bool, ?type: bool) -> void - - def to_hash: -> FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::entity end type locations = @@ -373,37 +357,33 @@ module FinchAPI ?postal_code: bool, ?state: bool ) -> void - - def to_hash: -> FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::locations end end type directory = { - individuals: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Directory::Individuals, - paging: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Directory::Paging + individuals: FinchAPI::Provider::AuthenticationMethod::SupportedFields::Directory::Individuals, + paging: FinchAPI::Provider::AuthenticationMethod::SupportedFields::Directory::Paging } class Directory < FinchAPI::Internal::Type::BaseModel - attr_reader individuals: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Directory::Individuals? + attr_reader individuals: FinchAPI::Provider::AuthenticationMethod::SupportedFields::Directory::Individuals? def individuals=: ( - FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Directory::Individuals - ) -> FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Directory::Individuals + FinchAPI::Provider::AuthenticationMethod::SupportedFields::Directory::Individuals + ) -> FinchAPI::Provider::AuthenticationMethod::SupportedFields::Directory::Individuals - attr_reader paging: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Directory::Paging? + attr_reader paging: FinchAPI::Provider::AuthenticationMethod::SupportedFields::Directory::Paging? def paging=: ( - FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Directory::Paging - ) -> FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Directory::Paging + FinchAPI::Provider::AuthenticationMethod::SupportedFields::Directory::Paging + ) -> FinchAPI::Provider::AuthenticationMethod::SupportedFields::Directory::Paging def initialize: ( - ?individuals: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Directory::Individuals, - ?paging: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Directory::Paging + ?individuals: FinchAPI::Provider::AuthenticationMethod::SupportedFields::Directory::Individuals, + ?paging: FinchAPI::Provider::AuthenticationMethod::SupportedFields::Directory::Paging ) -> void - def to_hash: -> FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::directory - type individuals = { id: bool, @@ -411,7 +391,7 @@ module FinchAPI first_name: bool, is_active: bool, last_name: bool, - manager: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Directory::Individuals::Manager, + manager: FinchAPI::Provider::AuthenticationMethod::SupportedFields::Directory::Individuals::Manager, middle_name: bool } @@ -436,11 +416,11 @@ module FinchAPI def last_name=: (bool) -> bool - attr_reader manager: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Directory::Individuals::Manager? + attr_reader manager: FinchAPI::Provider::AuthenticationMethod::SupportedFields::Directory::Individuals::Manager? def manager=: ( - FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Directory::Individuals::Manager - ) -> FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Directory::Individuals::Manager + FinchAPI::Provider::AuthenticationMethod::SupportedFields::Directory::Individuals::Manager + ) -> FinchAPI::Provider::AuthenticationMethod::SupportedFields::Directory::Individuals::Manager attr_reader middle_name: bool? @@ -452,12 +432,10 @@ module FinchAPI ?first_name: bool, ?is_active: bool, ?last_name: bool, - ?manager: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Directory::Individuals::Manager, + ?manager: FinchAPI::Provider::AuthenticationMethod::SupportedFields::Directory::Individuals::Manager, ?middle_name: bool ) -> void - def to_hash: -> FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Directory::individuals - type manager = { id: bool } class Manager < FinchAPI::Internal::Type::BaseModel @@ -466,8 +444,6 @@ module FinchAPI def id=: (bool) -> bool def initialize: (?id: bool) -> void - - def to_hash: -> FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Directory::Individuals::manager end end @@ -483,8 +459,6 @@ module FinchAPI def offset=: (bool) -> bool def initialize: (?count: bool, ?offset: bool) -> void - - def to_hash: -> FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Directory::paging end end @@ -493,17 +467,17 @@ module FinchAPI id: bool, class_code: bool, custom_fields: bool, - department: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::Department, - employment: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::Employment, + department: FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment::Department, + employment: FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment::Employment, employment_status: bool, end_date: bool, first_name: bool, - income: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::Income, + income: FinchAPI::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, + location: FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment::Location, + manager: FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment::Manager, middle_name: bool, start_date: bool, title: bool @@ -522,17 +496,17 @@ module FinchAPI def custom_fields=: (bool) -> bool - attr_reader department: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::Department? + attr_reader department: FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment::Department? def department=: ( - FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::Department - ) -> FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::Department + FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment::Department + ) -> FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment::Department - attr_reader employment: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::Employment? + attr_reader employment: FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment::Employment? def employment=: ( - FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::Employment - ) -> FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::Employment + FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment::Employment + ) -> FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment::Employment attr_reader employment_status: bool? @@ -546,11 +520,11 @@ module FinchAPI def first_name=: (bool) -> bool - attr_reader income: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::Income? + attr_reader income: FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment::Income? def income=: ( - FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::Income - ) -> FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::Income + FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment::Income + ) -> FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment::Income attr_reader income_history: bool? @@ -564,17 +538,17 @@ module FinchAPI def last_name=: (bool) -> bool - attr_reader location: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::Location? + attr_reader location: FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment::Location? def location=: ( - FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::Location - ) -> FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::Location + FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment::Location + ) -> FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment::Location - attr_reader manager: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::Manager? + attr_reader manager: FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment::Manager? def manager=: ( - FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::Manager - ) -> FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::Manager + FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment::Manager + ) -> FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment::Manager attr_reader middle_name: bool? @@ -592,24 +566,22 @@ module FinchAPI ?id: bool, ?class_code: bool, ?custom_fields: bool, - ?department: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::Department, - ?employment: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::Employment, + ?department: FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment::Department, + ?employment: FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment::Employment, ?employment_status: bool, ?end_date: bool, ?first_name: bool, - ?income: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::Income, + ?income: FinchAPI::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, + ?location: FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment::Location, + ?manager: FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment::Manager, ?middle_name: bool, ?start_date: bool, ?title: bool ) -> void - def to_hash: -> FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::employment - type department = { name: bool } class Department < FinchAPI::Internal::Type::BaseModel @@ -618,8 +590,6 @@ module FinchAPI def name=: (bool) -> bool def initialize: (?name: bool) -> void - - def to_hash: -> FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::department end type employment = { subtype: bool, type: bool } @@ -634,8 +604,6 @@ module FinchAPI def type=: (bool) -> bool def initialize: (?subtype: bool, ?type: bool) -> void - - def to_hash: -> FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::employment end type income = { amount: bool, currency: bool, unit: bool } @@ -658,8 +626,6 @@ module FinchAPI ?currency: bool, ?unit: bool ) -> void - - def to_hash: -> FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::income end type location = @@ -705,8 +671,6 @@ module FinchAPI ?postal_code: bool, ?state: bool ) -> void - - def to_hash: -> FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::location end type manager = { id: bool } @@ -717,8 +681,6 @@ module FinchAPI def id=: (bool) -> bool def initialize: (?id: bool) -> void - - def to_hash: -> FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::manager end end @@ -726,16 +688,16 @@ module FinchAPI { id: bool, dob: bool, - emails: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Individual::Emails, + emails: FinchAPI::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, + phone_numbers: FinchAPI::Provider::AuthenticationMethod::SupportedFields::Individual::PhoneNumbers, preferred_name: bool, - residence: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Individual::Residence, + residence: FinchAPI::Provider::AuthenticationMethod::SupportedFields::Individual::Residence, ssn: bool } @@ -748,11 +710,11 @@ module FinchAPI def dob=: (bool) -> bool - attr_reader emails: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Individual::Emails? + attr_reader emails: FinchAPI::Provider::AuthenticationMethod::SupportedFields::Individual::Emails? def emails=: ( - FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Individual::Emails - ) -> FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Individual::Emails + FinchAPI::Provider::AuthenticationMethod::SupportedFields::Individual::Emails + ) -> FinchAPI::Provider::AuthenticationMethod::SupportedFields::Individual::Emails attr_reader encrypted_ssn: bool? @@ -778,21 +740,21 @@ module FinchAPI def middle_name=: (bool) -> bool - attr_reader phone_numbers: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Individual::PhoneNumbers? + attr_reader phone_numbers: FinchAPI::Provider::AuthenticationMethod::SupportedFields::Individual::PhoneNumbers? def phone_numbers=: ( - FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Individual::PhoneNumbers - ) -> FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Individual::PhoneNumbers + FinchAPI::Provider::AuthenticationMethod::SupportedFields::Individual::PhoneNumbers + ) -> FinchAPI::Provider::AuthenticationMethod::SupportedFields::Individual::PhoneNumbers attr_reader preferred_name: bool? def preferred_name=: (bool) -> bool - attr_reader residence: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Individual::Residence? + attr_reader residence: FinchAPI::Provider::AuthenticationMethod::SupportedFields::Individual::Residence? def residence=: ( - FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Individual::Residence - ) -> FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Individual::Residence + FinchAPI::Provider::AuthenticationMethod::SupportedFields::Individual::Residence + ) -> FinchAPI::Provider::AuthenticationMethod::SupportedFields::Individual::Residence attr_reader ssn: bool? @@ -801,21 +763,19 @@ module FinchAPI def initialize: ( ?id: bool, ?dob: bool, - ?emails: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Individual::Emails, + ?emails: FinchAPI::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, + ?phone_numbers: FinchAPI::Provider::AuthenticationMethod::SupportedFields::Individual::PhoneNumbers, ?preferred_name: bool, - ?residence: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Individual::Residence, + ?residence: FinchAPI::Provider::AuthenticationMethod::SupportedFields::Individual::Residence, ?ssn: bool ) -> void - def to_hash: -> FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::individual - type emails = { data: bool, type: bool } class Emails < FinchAPI::Internal::Type::BaseModel @@ -828,8 +788,6 @@ module FinchAPI def type=: (bool) -> bool def initialize: (?data: bool, ?type: bool) -> void - - def to_hash: -> FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Individual::emails end type phone_numbers = { data: bool, type: bool } @@ -844,8 +802,6 @@ module FinchAPI def type=: (bool) -> bool def initialize: (?data: bool, ?type: bool) -> void - - def to_hash: -> FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Individual::phone_numbers end type residence = @@ -891,8 +847,6 @@ module FinchAPI ?postal_code: bool, ?state: bool ) -> void - - def to_hash: -> FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Individual::residence end end @@ -927,36 +881,32 @@ module FinchAPI ?name: bool, ?pay_frequencies: bool ) -> void - - def to_hash: -> FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::pay_group end type pay_statement = { - paging: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::Paging, - pay_statements: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements + paging: FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::Paging, + pay_statements: FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements } class PayStatement < FinchAPI::Internal::Type::BaseModel - attr_reader paging: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::Paging? + attr_reader paging: FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::Paging? def paging=: ( - FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::Paging - ) -> FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::Paging + FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::Paging + ) -> FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::Paging - attr_reader pay_statements: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements? + attr_reader pay_statements: FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements? def pay_statements=: ( - FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements - ) -> FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements + FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements + ) -> FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements def initialize: ( - ?paging: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::Paging, - ?pay_statements: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements + ?paging: FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::Paging, + ?pay_statements: FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements ) -> void - def to_hash: -> FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::pay_statement - type paging = { count: bool, offset: bool } class Paging < FinchAPI::Internal::Type::BaseModel @@ -965,42 +915,40 @@ module FinchAPI attr_accessor offset: bool def initialize: (count: bool, offset: bool) -> void - - def to_hash: -> FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::paging end type pay_statements = { - 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: FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Earnings, + employee_deductions: FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployeeDeductions, + employer_contributions: FinchAPI::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, + taxes: FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Taxes, total_hours: bool, type: bool } class PayStatements < FinchAPI::Internal::Type::BaseModel - attr_reader earnings: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Earnings? + attr_reader earnings: FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Earnings? def earnings=: ( - FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Earnings - ) -> FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Earnings + FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Earnings + ) -> FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Earnings - attr_reader employee_deductions: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployeeDeductions? + attr_reader employee_deductions: FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployeeDeductions? def employee_deductions=: ( - FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployeeDeductions - ) -> FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployeeDeductions + FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployeeDeductions + ) -> FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployeeDeductions - attr_reader employer_contributions: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployerContributions? + attr_reader employer_contributions: FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployerContributions? def employer_contributions=: ( - FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployerContributions - ) -> FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployerContributions + FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployerContributions + ) -> FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployerContributions attr_reader gross_pay: bool? @@ -1018,11 +966,11 @@ module FinchAPI def payment_method=: (bool) -> bool - attr_reader taxes: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Taxes? + attr_reader taxes: FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Taxes? def taxes=: ( - FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Taxes - ) -> FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Taxes + FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Taxes + ) -> FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Taxes attr_reader total_hours: bool? @@ -1033,20 +981,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, + ?earnings: FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Earnings, + ?employee_deductions: FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployeeDeductions, + ?employer_contributions: FinchAPI::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, + ?taxes: FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Taxes, ?total_hours: bool, ?type: bool ) -> void - def to_hash: -> FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::pay_statements - type earnings = { amount: bool, currency: bool, name: bool, type: bool } @@ -1073,8 +1019,6 @@ module FinchAPI ?name: bool, ?type: bool ) -> void - - def to_hash: -> FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::earnings end type employee_deductions = @@ -1114,8 +1058,6 @@ module FinchAPI ?pre_tax: bool, ?type: bool ) -> void - - def to_hash: -> FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::employee_deductions end type employer_contributions = @@ -1139,8 +1081,6 @@ module FinchAPI ?currency: bool, ?name: bool ) -> void - - def to_hash: -> FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::employer_contributions end type taxes = @@ -1180,8 +1120,6 @@ module FinchAPI ?name: bool, ?type: bool ) -> void - - def to_hash: -> FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::taxes end end end @@ -1199,7 +1137,7 @@ module FinchAPI pay_date: bool, pay_frequencies: bool, pay_group_ids: bool, - pay_period: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Payment::PayPeriod + pay_period: FinchAPI::Provider::AuthenticationMethod::SupportedFields::Payment::PayPeriod } class Payment < FinchAPI::Internal::Type::BaseModel @@ -1247,11 +1185,11 @@ module FinchAPI def pay_group_ids=: (bool) -> bool - attr_reader pay_period: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Payment::PayPeriod? + attr_reader pay_period: FinchAPI::Provider::AuthenticationMethod::SupportedFields::Payment::PayPeriod? def pay_period=: ( - FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Payment::PayPeriod - ) -> FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Payment::PayPeriod + FinchAPI::Provider::AuthenticationMethod::SupportedFields::Payment::PayPeriod + ) -> FinchAPI::Provider::AuthenticationMethod::SupportedFields::Payment::PayPeriod def initialize: ( ?id: bool, @@ -1265,11 +1203,9 @@ module FinchAPI ?pay_date: bool, ?pay_frequencies: bool, ?pay_group_ids: bool, - ?pay_period: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Payment::PayPeriod + ?pay_period: FinchAPI::Provider::AuthenticationMethod::SupportedFields::Payment::PayPeriod ) -> void - def to_hash: -> FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::payment - type pay_period = { end_date: bool, start_date: bool } class PayPeriod < FinchAPI::Internal::Type::BaseModel @@ -1282,8 +1218,6 @@ module FinchAPI def start_date=: (bool) -> bool def initialize: (?end_date: bool, ?start_date: bool) -> void - - def to_hash: -> FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Payment::pay_period end end end @@ -1300,7 +1234,7 @@ module FinchAPI API_CREDENTIAL: :api_credential OAUTH: :oauth - def self?.values: -> ::Array[FinchAPI::Models::Provider::AuthenticationMethod::type_] + def self?.values: -> ::Array[FinchAPI::Provider::AuthenticationMethod::type_] end end end diff --git a/sig/finch_api/models/provider_list_params.rbs b/sig/finch_api/models/provider_list_params.rbs index 37e793d2..c276a697 100644 --- a/sig/finch_api/models/provider_list_params.rbs +++ b/sig/finch_api/models/provider_list_params.rbs @@ -8,8 +8,6 @@ module FinchAPI include FinchAPI::Internal::Type::RequestParameters def initialize: (?request_options: FinchAPI::request_opts) -> void - - def to_hash: -> FinchAPI::Models::provider_list_params end end end diff --git a/sig/finch_api/models/request_forwarding_forward_params.rbs b/sig/finch_api/models/request_forwarding_forward_params.rbs index e0b85fbc..88aaf364 100644 --- a/sig/finch_api/models/request_forwarding_forward_params.rbs +++ b/sig/finch_api/models/request_forwarding_forward_params.rbs @@ -32,8 +32,6 @@ module FinchAPI ?params: top?, ?request_options: FinchAPI::request_opts ) -> void - - def to_hash: -> FinchAPI::Models::request_forwarding_forward_params end end end diff --git a/sig/finch_api/models/request_forwarding_forward_response.rbs b/sig/finch_api/models/request_forwarding_forward_response.rbs index c4f9f91a..b53af075 100644 --- a/sig/finch_api/models/request_forwarding_forward_response.rbs +++ b/sig/finch_api/models/request_forwarding_forward_response.rbs @@ -24,8 +24,6 @@ module FinchAPI status_code: Integer ) -> void - def to_hash: -> FinchAPI::Models::request_forwarding_forward_response - type request = { data: String?, @@ -53,8 +51,6 @@ module FinchAPI params: top?, route: String ) -> void - - def to_hash: -> FinchAPI::Models::RequestForwardingForwardResponse::request 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 2d9c5010..f9240957 100644 --- a/sig/finch_api/models/sandbox/company_update_params.rbs +++ b/sig/finch_api/models/sandbox/company_update_params.rbs @@ -3,12 +3,12 @@ module FinchAPI module Sandbox type company_update_params = { - accounts: ::Array[FinchAPI::Models::Sandbox::CompanyUpdateParams::Account]?, - departments: ::Array[FinchAPI::Models::Sandbox::CompanyUpdateParams::Department?]?, + accounts: ::Array[FinchAPI::Sandbox::CompanyUpdateParams::Account]?, + departments: ::Array[FinchAPI::Sandbox::CompanyUpdateParams::Department?]?, ein: String?, - entity: FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity?, + entity: FinchAPI::Sandbox::CompanyUpdateParams::Entity?, legal_name: String?, - locations: ::Array[FinchAPI::Models::Location?]?, + locations: ::Array[FinchAPI::Location?]?, primary_email: String?, primary_phone_number: String? } @@ -18,41 +18,39 @@ module FinchAPI extend FinchAPI::Internal::Type::RequestParameters::Converter include FinchAPI::Internal::Type::RequestParameters - attr_accessor accounts: ::Array[FinchAPI::Models::Sandbox::CompanyUpdateParams::Account]? + attr_accessor accounts: ::Array[FinchAPI::Sandbox::CompanyUpdateParams::Account]? - attr_accessor departments: ::Array[FinchAPI::Models::Sandbox::CompanyUpdateParams::Department?]? + attr_accessor departments: ::Array[FinchAPI::Sandbox::CompanyUpdateParams::Department?]? attr_accessor ein: String? - attr_accessor entity: FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity? + attr_accessor entity: FinchAPI::Sandbox::CompanyUpdateParams::Entity? attr_accessor legal_name: String? - attr_accessor locations: ::Array[FinchAPI::Models::Location?]? + attr_accessor locations: ::Array[FinchAPI::Location?]? attr_accessor primary_email: String? attr_accessor primary_phone_number: String? def initialize: ( - accounts: ::Array[FinchAPI::Models::Sandbox::CompanyUpdateParams::Account]?, - departments: ::Array[FinchAPI::Models::Sandbox::CompanyUpdateParams::Department?]?, + accounts: ::Array[FinchAPI::Sandbox::CompanyUpdateParams::Account]?, + departments: ::Array[FinchAPI::Sandbox::CompanyUpdateParams::Department?]?, ein: String?, - entity: FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity?, + entity: FinchAPI::Sandbox::CompanyUpdateParams::Entity?, legal_name: String?, - locations: ::Array[FinchAPI::Models::Location?]?, + locations: ::Array[FinchAPI::Location?]?, primary_email: String?, primary_phone_number: String?, ?request_options: FinchAPI::request_opts ) -> void - def to_hash: -> FinchAPI::Models::Sandbox::company_update_params - type account = { account_name: String?, account_number: String?, - account_type: FinchAPI::Models::Sandbox::CompanyUpdateParams::Account::account_type?, + account_type: FinchAPI::Sandbox::CompanyUpdateParams::Account::account_type?, institution_name: String?, routing_number: String? } @@ -62,7 +60,7 @@ module FinchAPI attr_accessor account_number: String? - attr_accessor account_type: FinchAPI::Models::Sandbox::CompanyUpdateParams::Account::account_type? + attr_accessor account_type: FinchAPI::Sandbox::CompanyUpdateParams::Account::account_type? attr_accessor institution_name: String? @@ -71,13 +69,11 @@ module FinchAPI def initialize: ( ?account_name: String?, ?account_number: String?, - ?account_type: FinchAPI::Models::Sandbox::CompanyUpdateParams::Account::account_type?, + ?account_type: FinchAPI::Sandbox::CompanyUpdateParams::Account::account_type?, ?institution_name: String?, ?routing_number: String? ) -> void - def to_hash: -> FinchAPI::Models::Sandbox::CompanyUpdateParams::account - type account_type = :checking | :savings module AccountType @@ -86,57 +82,51 @@ module FinchAPI CHECKING: :checking SAVINGS: :savings - def self?.values: -> ::Array[FinchAPI::Models::Sandbox::CompanyUpdateParams::Account::account_type] + def self?.values: -> ::Array[FinchAPI::Sandbox::CompanyUpdateParams::Account::account_type] end end type department = { name: String?, - parent: FinchAPI::Models::Sandbox::CompanyUpdateParams::Department::Parent? + parent: FinchAPI::Sandbox::CompanyUpdateParams::Department::Parent? } class Department < FinchAPI::Internal::Type::BaseModel attr_accessor name: String? - attr_accessor parent: FinchAPI::Models::Sandbox::CompanyUpdateParams::Department::Parent? + attr_accessor parent: FinchAPI::Sandbox::CompanyUpdateParams::Department::Parent? def initialize: ( ?name: String?, - ?parent: FinchAPI::Models::Sandbox::CompanyUpdateParams::Department::Parent? + ?parent: FinchAPI::Sandbox::CompanyUpdateParams::Department::Parent? ) -> void - def to_hash: -> FinchAPI::Models::Sandbox::CompanyUpdateParams::department - type parent = { name: String? } class Parent < FinchAPI::Internal::Type::BaseModel attr_accessor name: String? def initialize: (?name: String?) -> void - - def to_hash: -> FinchAPI::Models::Sandbox::CompanyUpdateParams::Department::parent end end type entity = { - subtype: FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity::subtype?, - type: FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity::type_? + subtype: FinchAPI::Sandbox::CompanyUpdateParams::Entity::subtype?, + type: FinchAPI::Sandbox::CompanyUpdateParams::Entity::type_? } class Entity < FinchAPI::Internal::Type::BaseModel - attr_accessor subtype: FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity::subtype? + attr_accessor subtype: FinchAPI::Sandbox::CompanyUpdateParams::Entity::subtype? - attr_accessor type: FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity::type_? + attr_accessor type: FinchAPI::Sandbox::CompanyUpdateParams::Entity::type_? def initialize: ( - ?subtype: FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity::subtype?, - ?type: FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity::type_? + ?subtype: FinchAPI::Sandbox::CompanyUpdateParams::Entity::subtype?, + ?type: FinchAPI::Sandbox::CompanyUpdateParams::Entity::type_? ) -> void - def to_hash: -> FinchAPI::Models::Sandbox::CompanyUpdateParams::entity - type subtype = :s_corporation | :c_corporation | :b_corporation module Subtype @@ -146,7 +136,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::Sandbox::CompanyUpdateParams::Entity::subtype] end type type_ = @@ -169,7 +159,7 @@ module FinchAPI PARTNERSHIP: :partnership COOPERATIVE: :cooperative - def self?.values: -> ::Array[FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity::type_] + def self?.values: -> ::Array[FinchAPI::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 911b2b9e..3433a748 100644 --- a/sig/finch_api/models/sandbox/company_update_response.rbs +++ b/sig/finch_api/models/sandbox/company_update_response.rbs @@ -8,7 +8,7 @@ module FinchAPI ein: String?, entity: FinchAPI::Models::Sandbox::CompanyUpdateResponse::Entity?, legal_name: String?, - locations: ::Array[FinchAPI::Models::Location?]?, + locations: ::Array[FinchAPI::Location?]?, primary_email: String?, primary_phone_number: String? } @@ -24,7 +24,7 @@ module FinchAPI attr_accessor legal_name: String? - attr_accessor locations: ::Array[FinchAPI::Models::Location?]? + attr_accessor locations: ::Array[FinchAPI::Location?]? attr_accessor primary_email: String? @@ -36,13 +36,11 @@ module FinchAPI ein: String?, entity: FinchAPI::Models::Sandbox::CompanyUpdateResponse::Entity?, legal_name: String?, - locations: ::Array[FinchAPI::Models::Location?]?, + locations: ::Array[FinchAPI::Location?]?, primary_email: String?, primary_phone_number: String? ) -> void - def to_hash: -> FinchAPI::Models::Sandbox::company_update_response - type account = { account_name: String?, @@ -71,8 +69,6 @@ module FinchAPI ?routing_number: String? ) -> void - def to_hash: -> FinchAPI::Models::Sandbox::CompanyUpdateResponse::account - type account_type = :checking | :savings module AccountType @@ -101,16 +97,12 @@ module FinchAPI ?parent: FinchAPI::Models::Sandbox::CompanyUpdateResponse::Department::Parent? ) -> void - def to_hash: -> FinchAPI::Models::Sandbox::CompanyUpdateResponse::department - type parent = { name: String? } class Parent < FinchAPI::Internal::Type::BaseModel attr_accessor name: String? def initialize: (?name: String?) -> void - - def to_hash: -> FinchAPI::Models::Sandbox::CompanyUpdateResponse::Department::parent end end @@ -130,8 +122,6 @@ module FinchAPI ?type: FinchAPI::Models::Sandbox::CompanyUpdateResponse::Entity::type_? ) -> void - def to_hash: -> FinchAPI::Models::Sandbox::CompanyUpdateResponse::entity - type subtype = :s_corporation | :c_corporation | :b_corporation module Subtype diff --git a/sig/finch_api/models/sandbox/connection_create_params.rbs b/sig/finch_api/models/sandbox/connection_create_params.rbs index 7900b7a4..e36f46ea 100644 --- a/sig/finch_api/models/sandbox/connection_create_params.rbs +++ b/sig/finch_api/models/sandbox/connection_create_params.rbs @@ -38,8 +38,6 @@ module FinchAPI ?request_options: FinchAPI::request_opts ) -> void - def to_hash: -> FinchAPI::Models::Sandbox::connection_create_params - type authentication_type = :credential | :api_token | :oauth | :assisted module AuthenticationType diff --git a/sig/finch_api/models/sandbox/connection_create_response.rbs b/sig/finch_api/models/sandbox/connection_create_response.rbs index 50e73a8f..389ec50b 100644 --- a/sig/finch_api/models/sandbox/connection_create_response.rbs +++ b/sig/finch_api/models/sandbox/connection_create_response.rbs @@ -43,8 +43,6 @@ module FinchAPI ?token_type: String ) -> void - def to_hash: -> FinchAPI::Models::Sandbox::connection_create_response - type authentication_type = :credential | :api_token | :oauth | :assisted module AuthenticationType 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 957d22ac..0f5766d2 100644 --- a/sig/finch_api/models/sandbox/connections/account_create_params.rbs +++ b/sig/finch_api/models/sandbox/connections/account_create_params.rbs @@ -37,8 +37,6 @@ module FinchAPI ?request_options: FinchAPI::request_opts ) -> void - def to_hash: -> FinchAPI::Models::Sandbox::Connections::account_create_params - type authentication_type = :credential | :api_token | :oauth | :assisted 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 cc1f0a54..959779a2 100644 --- a/sig/finch_api/models/sandbox/connections/account_create_response.rbs +++ b/sig/finch_api/models/sandbox/connections/account_create_response.rbs @@ -38,8 +38,6 @@ module FinchAPI provider_id: String ) -> void - def to_hash: -> FinchAPI::Models::Sandbox::Connections::account_create_response - type authentication_type = :credential | :api_token | :oauth | :assisted 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 c7769181..bd373242 100644 --- a/sig/finch_api/models/sandbox/connections/account_update_params.rbs +++ b/sig/finch_api/models/sandbox/connections/account_update_params.rbs @@ -20,8 +20,6 @@ module FinchAPI ?connection_status: FinchAPI::Models::connection_status_type, ?request_options: FinchAPI::request_opts ) -> void - - def to_hash: -> FinchAPI::Models::Sandbox::Connections::account_update_params 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 f4f1790a..a25b0b47 100644 --- a/sig/finch_api/models/sandbox/connections/account_update_response.rbs +++ b/sig/finch_api/models/sandbox/connections/account_update_response.rbs @@ -36,8 +36,6 @@ module FinchAPI ?connection_id: String ) -> void - def to_hash: -> FinchAPI::Models::Sandbox::Connections::account_update_response - type authentication_type = :credential | :api_token | :oauth | :assisted diff --git a/sig/finch_api/models/sandbox/directory_create_params.rbs b/sig/finch_api/models/sandbox/directory_create_params.rbs index c5b61dd2..a7902050 100644 --- a/sig/finch_api/models/sandbox/directory_create_params.rbs +++ b/sig/finch_api/models/sandbox/directory_create_params.rbs @@ -2,53 +2,49 @@ module FinchAPI module Models module Sandbox type directory_create_params = - { - body: ::Array[FinchAPI::Models::Sandbox::DirectoryCreateParams::Body] - } + { body: ::Array[FinchAPI::Sandbox::DirectoryCreateParams::Body] } & FinchAPI::Internal::Type::request_parameters class DirectoryCreateParams < FinchAPI::Internal::Type::BaseModel extend FinchAPI::Internal::Type::RequestParameters::Converter include FinchAPI::Internal::Type::RequestParameters - attr_reader body: ::Array[FinchAPI::Models::Sandbox::DirectoryCreateParams::Body]? + attr_reader body: ::Array[FinchAPI::Sandbox::DirectoryCreateParams::Body]? def body=: ( - ::Array[FinchAPI::Models::Sandbox::DirectoryCreateParams::Body] - ) -> ::Array[FinchAPI::Models::Sandbox::DirectoryCreateParams::Body] + ::Array[FinchAPI::Sandbox::DirectoryCreateParams::Body] + ) -> ::Array[FinchAPI::Sandbox::DirectoryCreateParams::Body] def initialize: ( - ?body: ::Array[FinchAPI::Models::Sandbox::DirectoryCreateParams::Body], + ?body: ::Array[FinchAPI::Sandbox::DirectoryCreateParams::Body], ?request_options: FinchAPI::request_opts ) -> void - def to_hash: -> FinchAPI::Models::Sandbox::directory_create_params - type body = { class_code: String?, - custom_fields: ::Array[FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::CustomField], - department: FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Department?, + custom_fields: ::Array[FinchAPI::Sandbox::DirectoryCreateParams::Body::CustomField], + department: FinchAPI::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?, + emails: ::Array[FinchAPI::Sandbox::DirectoryCreateParams::Body::Email]?, + employment: FinchAPI::Sandbox::DirectoryCreateParams::Body::Employment?, + employment_status: FinchAPI::Sandbox::DirectoryCreateParams::Body::employment_status?, encrypted_ssn: String?, end_date: String?, - ethnicity: FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::ethnicity?, + ethnicity: FinchAPI::Sandbox::DirectoryCreateParams::Body::ethnicity?, first_name: String?, - gender: FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::gender?, - income: FinchAPI::Models::Income?, - income_history: ::Array[FinchAPI::Models::Income?]?, + gender: FinchAPI::Sandbox::DirectoryCreateParams::Body::gender?, + income: FinchAPI::Income?, + income_history: ::Array[FinchAPI::Income?]?, is_active: bool?, last_name: String?, latest_rehire_date: String?, - location: FinchAPI::Models::Location?, - manager: FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Manager?, + location: FinchAPI::Location?, + manager: FinchAPI::Sandbox::DirectoryCreateParams::Body::Manager?, middle_name: String?, - phone_numbers: ::Array[FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::PhoneNumber?]?, + phone_numbers: ::Array[FinchAPI::Sandbox::DirectoryCreateParams::Body::PhoneNumber?]?, preferred_name: String?, - residence: FinchAPI::Models::Location?, + residence: FinchAPI::Location?, source_id: String, ssn: String?, start_date: String?, @@ -58,35 +54,35 @@ module FinchAPI class Body < FinchAPI::Internal::Type::BaseModel attr_accessor class_code: String? - attr_reader custom_fields: ::Array[FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::CustomField]? + attr_reader custom_fields: ::Array[FinchAPI::Sandbox::DirectoryCreateParams::Body::CustomField]? def custom_fields=: ( - ::Array[FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::CustomField] - ) -> ::Array[FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::CustomField] + ::Array[FinchAPI::Sandbox::DirectoryCreateParams::Body::CustomField] + ) -> ::Array[FinchAPI::Sandbox::DirectoryCreateParams::Body::CustomField] - attr_accessor department: FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Department? + attr_accessor department: FinchAPI::Sandbox::DirectoryCreateParams::Body::Department? attr_accessor dob: String? - attr_accessor emails: ::Array[FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Email]? + attr_accessor emails: ::Array[FinchAPI::Sandbox::DirectoryCreateParams::Body::Email]? - attr_accessor employment: FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment? + attr_accessor employment: FinchAPI::Sandbox::DirectoryCreateParams::Body::Employment? - attr_accessor employment_status: FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::employment_status? + attr_accessor employment_status: FinchAPI::Sandbox::DirectoryCreateParams::Body::employment_status? attr_accessor encrypted_ssn: String? attr_accessor end_date: String? - attr_accessor ethnicity: FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::ethnicity? + attr_accessor ethnicity: FinchAPI::Sandbox::DirectoryCreateParams::Body::ethnicity? attr_accessor first_name: String? - attr_accessor gender: FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::gender? + attr_accessor gender: FinchAPI::Sandbox::DirectoryCreateParams::Body::gender? - attr_accessor income: FinchAPI::Models::Income? + attr_accessor income: FinchAPI::Income? - attr_accessor income_history: ::Array[FinchAPI::Models::Income?]? + attr_accessor income_history: ::Array[FinchAPI::Income?]? attr_accessor is_active: bool? @@ -94,17 +90,17 @@ module FinchAPI attr_accessor latest_rehire_date: String? - attr_accessor location: FinchAPI::Models::Location? + attr_accessor location: FinchAPI::Location? - attr_accessor manager: FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Manager? + attr_accessor manager: FinchAPI::Sandbox::DirectoryCreateParams::Body::Manager? attr_accessor middle_name: String? - attr_accessor phone_numbers: ::Array[FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::PhoneNumber?]? + attr_accessor phone_numbers: ::Array[FinchAPI::Sandbox::DirectoryCreateParams::Body::PhoneNumber?]? attr_accessor preferred_name: String? - attr_accessor residence: FinchAPI::Models::Location? + attr_accessor residence: FinchAPI::Location? attr_reader source_id: String? @@ -118,36 +114,34 @@ module FinchAPI def initialize: ( ?class_code: String?, - ?custom_fields: ::Array[FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::CustomField], - ?department: FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Department?, + ?custom_fields: ::Array[FinchAPI::Sandbox::DirectoryCreateParams::Body::CustomField], + ?department: FinchAPI::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?, + ?emails: ::Array[FinchAPI::Sandbox::DirectoryCreateParams::Body::Email]?, + ?employment: FinchAPI::Sandbox::DirectoryCreateParams::Body::Employment?, + ?employment_status: FinchAPI::Sandbox::DirectoryCreateParams::Body::employment_status?, ?encrypted_ssn: String?, ?end_date: String?, - ?ethnicity: FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::ethnicity?, + ?ethnicity: FinchAPI::Sandbox::DirectoryCreateParams::Body::ethnicity?, ?first_name: String?, - ?gender: FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::gender?, - ?income: FinchAPI::Models::Income?, - ?income_history: ::Array[FinchAPI::Models::Income?]?, + ?gender: FinchAPI::Sandbox::DirectoryCreateParams::Body::gender?, + ?income: FinchAPI::Income?, + ?income_history: ::Array[FinchAPI::Income?]?, ?is_active: bool?, ?last_name: String?, ?latest_rehire_date: String?, - ?location: FinchAPI::Models::Location?, - ?manager: FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Manager?, + ?location: FinchAPI::Location?, + ?manager: FinchAPI::Sandbox::DirectoryCreateParams::Body::Manager?, ?middle_name: String?, - ?phone_numbers: ::Array[FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::PhoneNumber?]?, + ?phone_numbers: ::Array[FinchAPI::Sandbox::DirectoryCreateParams::Body::PhoneNumber?]?, ?preferred_name: String?, - ?residence: FinchAPI::Models::Location?, + ?residence: FinchAPI::Location?, ?source_id: String, ?ssn: String?, ?start_date: String?, ?title: String? ) -> void - def to_hash: -> FinchAPI::Models::Sandbox::DirectoryCreateParams::body - type custom_field = { name: String?, value: top } class CustomField < FinchAPI::Internal::Type::BaseModel @@ -158,8 +152,6 @@ module FinchAPI def value=: (top) -> top def initialize: (?name: String?, ?value: top) -> void - - def to_hash: -> FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::custom_field end type department = { name: String? } @@ -168,14 +160,12 @@ module FinchAPI attr_accessor name: String? def initialize: (?name: String?) -> void - - def to_hash: -> FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::department end type email = { data: String, - type: FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Email::type_? + type: FinchAPI::Sandbox::DirectoryCreateParams::Body::Email::type_? } class Email < FinchAPI::Internal::Type::BaseModel @@ -183,15 +173,13 @@ module FinchAPI def data=: (String) -> String - attr_accessor type: FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Email::type_? + attr_accessor type: FinchAPI::Sandbox::DirectoryCreateParams::Body::Email::type_? def initialize: ( ?data: String, - ?type: FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Email::type_? + ?type: FinchAPI::Sandbox::DirectoryCreateParams::Body::Email::type_? ) -> void - def to_hash: -> FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::email - type type_ = :work | :personal module Type @@ -200,28 +188,26 @@ module FinchAPI WORK: :work PERSONAL: :personal - def self?.values: -> ::Array[FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Email::type_] + def self?.values: -> ::Array[FinchAPI::Sandbox::DirectoryCreateParams::Body::Email::type_] end end type employment = { - subtype: FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment::subtype?, - type: FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment::type_? + subtype: FinchAPI::Sandbox::DirectoryCreateParams::Body::Employment::subtype?, + type: FinchAPI::Sandbox::DirectoryCreateParams::Body::Employment::type_? } class Employment < FinchAPI::Internal::Type::BaseModel - attr_accessor subtype: FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment::subtype? + attr_accessor subtype: FinchAPI::Sandbox::DirectoryCreateParams::Body::Employment::subtype? - attr_accessor type: FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment::type_? + attr_accessor type: FinchAPI::Sandbox::DirectoryCreateParams::Body::Employment::type_? def initialize: ( - ?subtype: FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment::subtype?, - ?type: FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment::type_? + ?subtype: FinchAPI::Sandbox::DirectoryCreateParams::Body::Employment::subtype?, + ?type: FinchAPI::Sandbox::DirectoryCreateParams::Body::Employment::type_? ) -> void - def to_hash: -> FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::employment - type subtype = :full_time | :intern @@ -240,7 +226,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::Sandbox::DirectoryCreateParams::Body::Employment::subtype] end type type_ = :employee | :contractor @@ -251,7 +237,7 @@ module FinchAPI EMPLOYEE: :employee CONTRACTOR: :contractor - def self?.values: -> ::Array[FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment::type_] + def self?.values: -> ::Array[FinchAPI::Sandbox::DirectoryCreateParams::Body::Employment::type_] end end @@ -275,7 +261,7 @@ module FinchAPI RETIRED: :retired TERMINATED: :terminated - def self?.values: -> ::Array[FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::employment_status] + def self?.values: -> ::Array[FinchAPI::Sandbox::DirectoryCreateParams::Body::employment_status] end type ethnicity = @@ -300,7 +286,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::Sandbox::DirectoryCreateParams::Body::ethnicity] end type gender = :female | :male | :other | :decline_to_specify @@ -313,7 +299,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::Sandbox::DirectoryCreateParams::Body::gender] end type manager = { id: String } @@ -324,28 +310,24 @@ module FinchAPI def id=: (String) -> String def initialize: (?id: String) -> void - - def to_hash: -> FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::manager end type phone_number = { data: String?, - type: FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::PhoneNumber::type_? + type: FinchAPI::Sandbox::DirectoryCreateParams::Body::PhoneNumber::type_? } class PhoneNumber < FinchAPI::Internal::Type::BaseModel attr_accessor data: String? - attr_accessor type: FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::PhoneNumber::type_? + attr_accessor type: FinchAPI::Sandbox::DirectoryCreateParams::Body::PhoneNumber::type_? def initialize: ( ?data: String?, - ?type: FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::PhoneNumber::type_? + ?type: FinchAPI::Sandbox::DirectoryCreateParams::Body::PhoneNumber::type_? ) -> void - def to_hash: -> FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::phone_number - type type_ = :work | :personal module Type @@ -354,7 +336,7 @@ module FinchAPI WORK: :work PERSONAL: :personal - def self?.values: -> ::Array[FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::PhoneNumber::type_] + def self?.values: -> ::Array[FinchAPI::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 df3214ff..c1390400 100644 --- a/sig/finch_api/models/sandbox/employment_update_params.rbs +++ b/sig/finch_api/models/sandbox/employment_update_params.rbs @@ -4,19 +4,19 @@ module FinchAPI type employment_update_params = { class_code: String?, - custom_fields: ::Array[FinchAPI::Models::Sandbox::EmploymentUpdateParams::CustomField], - department: FinchAPI::Models::Sandbox::EmploymentUpdateParams::Department?, - employment: FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment?, + custom_fields: ::Array[FinchAPI::Sandbox::EmploymentUpdateParams::CustomField], + department: FinchAPI::Sandbox::EmploymentUpdateParams::Department?, + employment: FinchAPI::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?]?, + income: FinchAPI::Income?, + income_history: ::Array[FinchAPI::Income?]?, is_active: bool?, last_name: String?, latest_rehire_date: String?, - location: FinchAPI::Models::Location?, - manager: FinchAPI::Models::Sandbox::EmploymentUpdateParams::Manager?, + location: FinchAPI::Location?, + manager: FinchAPI::Sandbox::EmploymentUpdateParams::Manager?, middle_name: String?, source_id: String, start_date: String?, @@ -30,15 +30,15 @@ module FinchAPI attr_accessor class_code: String? - attr_reader custom_fields: ::Array[FinchAPI::Models::Sandbox::EmploymentUpdateParams::CustomField]? + attr_reader custom_fields: ::Array[FinchAPI::Sandbox::EmploymentUpdateParams::CustomField]? def custom_fields=: ( - ::Array[FinchAPI::Models::Sandbox::EmploymentUpdateParams::CustomField] - ) -> ::Array[FinchAPI::Models::Sandbox::EmploymentUpdateParams::CustomField] + ::Array[FinchAPI::Sandbox::EmploymentUpdateParams::CustomField] + ) -> ::Array[FinchAPI::Sandbox::EmploymentUpdateParams::CustomField] - attr_accessor department: FinchAPI::Models::Sandbox::EmploymentUpdateParams::Department? + attr_accessor department: FinchAPI::Sandbox::EmploymentUpdateParams::Department? - attr_accessor employment: FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment? + attr_accessor employment: FinchAPI::Sandbox::EmploymentUpdateParams::Employment? attr_accessor employment_status: FinchAPI::Models::Sandbox::EmploymentUpdateParams::employment_status? @@ -46,9 +46,9 @@ module FinchAPI attr_accessor first_name: String? - attr_accessor income: FinchAPI::Models::Income? + attr_accessor income: FinchAPI::Income? - attr_accessor income_history: ::Array[FinchAPI::Models::Income?]? + attr_accessor income_history: ::Array[FinchAPI::Income?]? attr_accessor is_active: bool? @@ -56,9 +56,9 @@ module FinchAPI attr_accessor latest_rehire_date: String? - attr_accessor location: FinchAPI::Models::Location? + attr_accessor location: FinchAPI::Location? - attr_accessor manager: FinchAPI::Models::Sandbox::EmploymentUpdateParams::Manager? + attr_accessor manager: FinchAPI::Sandbox::EmploymentUpdateParams::Manager? attr_accessor middle_name: String? @@ -72,19 +72,19 @@ 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?, + ?custom_fields: ::Array[FinchAPI::Sandbox::EmploymentUpdateParams::CustomField], + ?department: FinchAPI::Sandbox::EmploymentUpdateParams::Department?, + ?employment: FinchAPI::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?]?, + ?income: FinchAPI::Income?, + ?income_history: ::Array[FinchAPI::Income?]?, ?is_active: bool?, ?last_name: String?, ?latest_rehire_date: String?, - ?location: FinchAPI::Models::Location?, - ?manager: FinchAPI::Models::Sandbox::EmploymentUpdateParams::Manager?, + ?location: FinchAPI::Location?, + ?manager: FinchAPI::Sandbox::EmploymentUpdateParams::Manager?, ?middle_name: String?, ?source_id: String, ?start_date: String?, @@ -92,8 +92,6 @@ module FinchAPI ?request_options: FinchAPI::request_opts ) -> void - def to_hash: -> FinchAPI::Models::Sandbox::employment_update_params - type custom_field = { name: String?, value: top } class CustomField < FinchAPI::Internal::Type::BaseModel @@ -104,8 +102,6 @@ module FinchAPI def value=: (top) -> top def initialize: (?name: String?, ?value: top) -> void - - def to_hash: -> FinchAPI::Models::Sandbox::EmploymentUpdateParams::custom_field end type department = { name: String? } @@ -114,28 +110,24 @@ module FinchAPI attr_accessor name: String? def initialize: (?name: String?) -> void - - def to_hash: -> FinchAPI::Models::Sandbox::EmploymentUpdateParams::department end type employment = { - subtype: FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment::subtype?, - type: FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment::type_? + subtype: FinchAPI::Sandbox::EmploymentUpdateParams::Employment::subtype?, + type: FinchAPI::Sandbox::EmploymentUpdateParams::Employment::type_? } class Employment < FinchAPI::Internal::Type::BaseModel - attr_accessor subtype: FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment::subtype? + attr_accessor subtype: FinchAPI::Sandbox::EmploymentUpdateParams::Employment::subtype? - attr_accessor type: FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment::type_? + attr_accessor type: FinchAPI::Sandbox::EmploymentUpdateParams::Employment::type_? def initialize: ( - ?subtype: FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment::subtype?, - ?type: FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment::type_? + ?subtype: FinchAPI::Sandbox::EmploymentUpdateParams::Employment::subtype?, + ?type: FinchAPI::Sandbox::EmploymentUpdateParams::Employment::type_? ) -> void - def to_hash: -> FinchAPI::Models::Sandbox::EmploymentUpdateParams::employment - type subtype = :full_time | :intern @@ -154,7 +146,7 @@ module FinchAPI SEASONAL: :seasonal INDIVIDUAL_CONTRACTOR: :individual_contractor - def self?.values: -> ::Array[FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment::subtype] + def self?.values: -> ::Array[FinchAPI::Sandbox::EmploymentUpdateParams::Employment::subtype] end type type_ = :employee | :contractor @@ -165,7 +157,7 @@ module FinchAPI EMPLOYEE: :employee CONTRACTOR: :contractor - def self?.values: -> ::Array[FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment::type_] + def self?.values: -> ::Array[FinchAPI::Sandbox::EmploymentUpdateParams::Employment::type_] end end @@ -200,8 +192,6 @@ module FinchAPI def id=: (String) -> String def initialize: (?id: String) -> void - - def to_hash: -> FinchAPI::Models::Sandbox::EmploymentUpdateParams::manager end end end diff --git a/sig/finch_api/models/sandbox/employment_update_response.rbs b/sig/finch_api/models/sandbox/employment_update_response.rbs index b6d0629e..457fdd8c 100644 --- a/sig/finch_api/models/sandbox/employment_update_response.rbs +++ b/sig/finch_api/models/sandbox/employment_update_response.rbs @@ -11,12 +11,12 @@ module FinchAPI employment_status: FinchAPI::Models::Sandbox::EmploymentUpdateResponse::employment_status?, end_date: String?, first_name: String?, - income: FinchAPI::Models::Income?, - income_history: ::Array[FinchAPI::Models::Income?]?, + income: FinchAPI::Income?, + income_history: ::Array[FinchAPI::Income?]?, is_active: bool?, last_name: String?, latest_rehire_date: String?, - location: FinchAPI::Models::Location?, + location: FinchAPI::Location?, manager: FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Manager?, middle_name: String?, source_id: String, @@ -47,9 +47,9 @@ module FinchAPI attr_accessor first_name: String? - attr_accessor income: FinchAPI::Models::Income? + attr_accessor income: FinchAPI::Income? - attr_accessor income_history: ::Array[FinchAPI::Models::Income?]? + attr_accessor income_history: ::Array[FinchAPI::Income?]? attr_accessor is_active: bool? @@ -57,7 +57,7 @@ module FinchAPI attr_accessor latest_rehire_date: String? - attr_accessor location: FinchAPI::Models::Location? + attr_accessor location: FinchAPI::Location? attr_accessor manager: FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Manager? @@ -80,12 +80,12 @@ module FinchAPI ?employment_status: FinchAPI::Models::Sandbox::EmploymentUpdateResponse::employment_status?, ?end_date: String?, ?first_name: String?, - ?income: FinchAPI::Models::Income?, - ?income_history: ::Array[FinchAPI::Models::Income?]?, + ?income: FinchAPI::Income?, + ?income_history: ::Array[FinchAPI::Income?]?, ?is_active: bool?, ?last_name: String?, ?latest_rehire_date: String?, - ?location: FinchAPI::Models::Location?, + ?location: FinchAPI::Location?, ?manager: FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Manager?, ?middle_name: String?, ?source_id: String, @@ -93,8 +93,6 @@ module FinchAPI ?title: String? ) -> void - def to_hash: -> FinchAPI::Models::Sandbox::employment_update_response - type custom_field = { name: String?, value: top } class CustomField < FinchAPI::Internal::Type::BaseModel @@ -105,8 +103,6 @@ module FinchAPI def value=: (top) -> top def initialize: (?name: String?, ?value: top) -> void - - def to_hash: -> FinchAPI::Models::Sandbox::EmploymentUpdateResponse::custom_field end type department = { name: String? } @@ -115,8 +111,6 @@ module FinchAPI attr_accessor name: String? def initialize: (?name: String?) -> void - - def to_hash: -> FinchAPI::Models::Sandbox::EmploymentUpdateResponse::department end type employment = @@ -135,8 +129,6 @@ module FinchAPI ?type: FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Employment::type_? ) -> void - def to_hash: -> FinchAPI::Models::Sandbox::EmploymentUpdateResponse::employment - type subtype = :full_time | :intern @@ -201,8 +193,6 @@ module FinchAPI def id=: (String) -> String def initialize: (?id: String) -> void - - def to_hash: -> FinchAPI::Models::Sandbox::EmploymentUpdateResponse::manager end end end diff --git a/sig/finch_api/models/sandbox/individual_update_params.rbs b/sig/finch_api/models/sandbox/individual_update_params.rbs index 08ba4003..8de8225f 100644 --- a/sig/finch_api/models/sandbox/individual_update_params.rbs +++ b/sig/finch_api/models/sandbox/individual_update_params.rbs @@ -4,16 +4,16 @@ module FinchAPI type individual_update_params = { dob: String?, - emails: ::Array[FinchAPI::Models::Sandbox::IndividualUpdateParams::Email]?, + emails: ::Array[FinchAPI::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?]?, + phone_numbers: ::Array[FinchAPI::Sandbox::IndividualUpdateParams::PhoneNumber?]?, preferred_name: String?, - residence: FinchAPI::Models::Location?, + residence: FinchAPI::Location?, ssn: String? } & FinchAPI::Internal::Type::request_parameters @@ -24,7 +24,7 @@ module FinchAPI attr_accessor dob: String? - attr_accessor emails: ::Array[FinchAPI::Models::Sandbox::IndividualUpdateParams::Email]? + attr_accessor emails: ::Array[FinchAPI::Sandbox::IndividualUpdateParams::Email]? attr_accessor encrypted_ssn: String? @@ -38,36 +38,34 @@ module FinchAPI attr_accessor middle_name: String? - attr_accessor phone_numbers: ::Array[FinchAPI::Models::Sandbox::IndividualUpdateParams::PhoneNumber?]? + attr_accessor phone_numbers: ::Array[FinchAPI::Sandbox::IndividualUpdateParams::PhoneNumber?]? attr_accessor preferred_name: String? - attr_accessor residence: FinchAPI::Models::Location? + attr_accessor residence: FinchAPI::Location? attr_accessor ssn: String? def initialize: ( ?dob: String?, - ?emails: ::Array[FinchAPI::Models::Sandbox::IndividualUpdateParams::Email]?, + ?emails: ::Array[FinchAPI::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?]?, + ?phone_numbers: ::Array[FinchAPI::Sandbox::IndividualUpdateParams::PhoneNumber?]?, ?preferred_name: String?, - ?residence: FinchAPI::Models::Location?, + ?residence: FinchAPI::Location?, ?ssn: String?, ?request_options: FinchAPI::request_opts ) -> void - def to_hash: -> FinchAPI::Models::Sandbox::individual_update_params - type email = { data: String, - type: FinchAPI::Models::Sandbox::IndividualUpdateParams::Email::type_? + type: FinchAPI::Sandbox::IndividualUpdateParams::Email::type_? } class Email < FinchAPI::Internal::Type::BaseModel @@ -75,15 +73,13 @@ module FinchAPI def data=: (String) -> String - attr_accessor type: FinchAPI::Models::Sandbox::IndividualUpdateParams::Email::type_? + attr_accessor type: FinchAPI::Sandbox::IndividualUpdateParams::Email::type_? def initialize: ( ?data: String, - ?type: FinchAPI::Models::Sandbox::IndividualUpdateParams::Email::type_? + ?type: FinchAPI::Sandbox::IndividualUpdateParams::Email::type_? ) -> void - def to_hash: -> FinchAPI::Models::Sandbox::IndividualUpdateParams::email - type type_ = :work | :personal module Type @@ -92,7 +88,7 @@ module FinchAPI WORK: :work PERSONAL: :personal - def self?.values: -> ::Array[FinchAPI::Models::Sandbox::IndividualUpdateParams::Email::type_] + def self?.values: -> ::Array[FinchAPI::Sandbox::IndividualUpdateParams::Email::type_] end end @@ -137,21 +133,19 @@ module FinchAPI type phone_number = { data: String?, - type: FinchAPI::Models::Sandbox::IndividualUpdateParams::PhoneNumber::type_? + type: FinchAPI::Sandbox::IndividualUpdateParams::PhoneNumber::type_? } class PhoneNumber < FinchAPI::Internal::Type::BaseModel attr_accessor data: String? - attr_accessor type: FinchAPI::Models::Sandbox::IndividualUpdateParams::PhoneNumber::type_? + attr_accessor type: FinchAPI::Sandbox::IndividualUpdateParams::PhoneNumber::type_? def initialize: ( ?data: String?, - ?type: FinchAPI::Models::Sandbox::IndividualUpdateParams::PhoneNumber::type_? + ?type: FinchAPI::Sandbox::IndividualUpdateParams::PhoneNumber::type_? ) -> void - def to_hash: -> FinchAPI::Models::Sandbox::IndividualUpdateParams::phone_number - type type_ = :work | :personal module Type @@ -160,7 +154,7 @@ module FinchAPI WORK: :work PERSONAL: :personal - def self?.values: -> ::Array[FinchAPI::Models::Sandbox::IndividualUpdateParams::PhoneNumber::type_] + def self?.values: -> ::Array[FinchAPI::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 b1b2d17a..70159e25 100644 --- a/sig/finch_api/models/sandbox/individual_update_response.rbs +++ b/sig/finch_api/models/sandbox/individual_update_response.rbs @@ -14,7 +14,7 @@ module FinchAPI middle_name: String?, phone_numbers: ::Array[FinchAPI::Models::Sandbox::IndividualUpdateResponse::PhoneNumber?]?, preferred_name: String?, - residence: FinchAPI::Models::Location?, + residence: FinchAPI::Location?, ssn: String? } @@ -43,7 +43,7 @@ module FinchAPI attr_accessor preferred_name: String? - attr_accessor residence: FinchAPI::Models::Location? + attr_accessor residence: FinchAPI::Location? attr_accessor ssn: String? @@ -59,12 +59,10 @@ module FinchAPI ?middle_name: String?, ?phone_numbers: ::Array[FinchAPI::Models::Sandbox::IndividualUpdateResponse::PhoneNumber?]?, ?preferred_name: String?, - ?residence: FinchAPI::Models::Location?, + ?residence: FinchAPI::Location?, ?ssn: String? ) -> void - def to_hash: -> FinchAPI::Models::Sandbox::individual_update_response - type email = { data: String, @@ -83,8 +81,6 @@ module FinchAPI ?type: FinchAPI::Models::Sandbox::IndividualUpdateResponse::Email::type_? ) -> void - def to_hash: -> FinchAPI::Models::Sandbox::IndividualUpdateResponse::email - type type_ = :work | :personal module Type @@ -151,8 +147,6 @@ module FinchAPI ?type: FinchAPI::Models::Sandbox::IndividualUpdateResponse::PhoneNumber::type_? ) -> void - def to_hash: -> FinchAPI::Models::Sandbox::IndividualUpdateResponse::phone_number - type type_ = :work | :personal module Type diff --git a/sig/finch_api/models/sandbox/job_create_params.rbs b/sig/finch_api/models/sandbox/job_create_params.rbs index b1ae643e..10c756a8 100644 --- a/sig/finch_api/models/sandbox/job_create_params.rbs +++ b/sig/finch_api/models/sandbox/job_create_params.rbs @@ -16,8 +16,6 @@ module FinchAPI ?request_options: FinchAPI::request_opts ) -> void - def to_hash: -> FinchAPI::Models::Sandbox::job_create_params - type type_ = :data_sync_all module Type diff --git a/sig/finch_api/models/sandbox/job_create_response.rbs b/sig/finch_api/models/sandbox/job_create_response.rbs index 7a97dc3b..e3eedc6c 100644 --- a/sig/finch_api/models/sandbox/job_create_response.rbs +++ b/sig/finch_api/models/sandbox/job_create_response.rbs @@ -24,8 +24,6 @@ module FinchAPI job_url: String, remaining_refreshes: Integer ) -> void - - def to_hash: -> FinchAPI::Models::Sandbox::job_create_response end end 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 ffd40caa..c661a565 100644 --- a/sig/finch_api/models/sandbox/jobs/configuration_retrieve_params.rbs +++ b/sig/finch_api/models/sandbox/jobs/configuration_retrieve_params.rbs @@ -10,8 +10,6 @@ module FinchAPI include FinchAPI::Internal::Type::RequestParameters def initialize: (?request_options: FinchAPI::request_opts) -> void - - def to_hash: -> FinchAPI::Models::Sandbox::Jobs::configuration_retrieve_params end end end diff --git a/sig/finch_api/models/sandbox/jobs/configuration_retrieve_response.rbs b/sig/finch_api/models/sandbox/jobs/configuration_retrieve_response.rbs index e45f57ab..1e698b0d 100644 --- a/sig/finch_api/models/sandbox/jobs/configuration_retrieve_response.rbs +++ b/sig/finch_api/models/sandbox/jobs/configuration_retrieve_response.rbs @@ -3,7 +3,7 @@ module FinchAPI module Sandbox module Jobs type configuration_retrieve_response = - ::Array[FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration] + ::Array[FinchAPI::Sandbox::Jobs::SandboxJobConfiguration] ConfigurationRetrieveResponse: FinchAPI::Internal::Type::Converter 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 37b9c597..9dabcff0 100644 --- a/sig/finch_api/models/sandbox/jobs/configuration_update_params.rbs +++ b/sig/finch_api/models/sandbox/jobs/configuration_update_params.rbs @@ -10,8 +10,6 @@ module FinchAPI include FinchAPI::Internal::Type::RequestParameters def initialize: (?request_options: FinchAPI::request_opts) -> void - - def to_hash: -> FinchAPI::Models::Sandbox::Jobs::configuration_update_params 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 d4647eff..d448d68d 100644 --- a/sig/finch_api/models/sandbox/jobs/sandbox_job_configuration.rbs +++ b/sig/finch_api/models/sandbox/jobs/sandbox_job_configuration.rbs @@ -4,22 +4,20 @@ module FinchAPI module Jobs type sandbox_job_configuration = { - completion_status: FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration::completion_status, - type: FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration::type_ + completion_status: FinchAPI::Sandbox::Jobs::SandboxJobConfiguration::completion_status, + type: FinchAPI::Sandbox::Jobs::SandboxJobConfiguration::type_ } class SandboxJobConfiguration < FinchAPI::Internal::Type::BaseModel - attr_accessor completion_status: FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration::completion_status + attr_accessor completion_status: FinchAPI::Sandbox::Jobs::SandboxJobConfiguration::completion_status - attr_accessor type: FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration::type_ + attr_accessor type: FinchAPI::Sandbox::Jobs::SandboxJobConfiguration::type_ def initialize: ( - completion_status: FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration::completion_status, - type: FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration::type_ + completion_status: FinchAPI::Sandbox::Jobs::SandboxJobConfiguration::completion_status, + type: FinchAPI::Sandbox::Jobs::SandboxJobConfiguration::type_ ) -> void - def to_hash: -> FinchAPI::Models::Sandbox::Jobs::sandbox_job_configuration - type completion_status = :complete | :reauth_error | :permissions_error | :error @@ -31,7 +29,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::Sandbox::Jobs::SandboxJobConfiguration::completion_status] end type type_ = :data_sync_all @@ -41,7 +39,7 @@ module FinchAPI DATA_SYNC_ALL: :data_sync_all - def self?.values: -> ::Array[FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration::type_] + def self?.values: -> ::Array[FinchAPI::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 2b90d74c..7019dbc7 100644 --- a/sig/finch_api/models/sandbox/payment_create_params.rbs +++ b/sig/finch_api/models/sandbox/payment_create_params.rbs @@ -4,7 +4,7 @@ module FinchAPI type payment_create_params = { end_date: String, - pay_statements: ::Array[FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement], + pay_statements: ::Array[FinchAPI::Sandbox::PaymentCreateParams::PayStatement], start_date: String } & FinchAPI::Internal::Type::request_parameters @@ -17,11 +17,11 @@ module FinchAPI def end_date=: (String) -> String - attr_reader pay_statements: ::Array[FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement]? + attr_reader pay_statements: ::Array[FinchAPI::Sandbox::PaymentCreateParams::PayStatement]? def pay_statements=: ( - ::Array[FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement] - ) -> ::Array[FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement] + ::Array[FinchAPI::Sandbox::PaymentCreateParams::PayStatement] + ) -> ::Array[FinchAPI::Sandbox::PaymentCreateParams::PayStatement] attr_reader start_date: String? @@ -29,79 +29,75 @@ module FinchAPI def initialize: ( ?end_date: String, - ?pay_statements: ::Array[FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement], + ?pay_statements: ::Array[FinchAPI::Sandbox::PaymentCreateParams::PayStatement], ?start_date: String, ?request_options: FinchAPI::request_opts ) -> void - def to_hash: -> FinchAPI::Models::Sandbox::payment_create_params - type pay_statement = { - 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?, + earnings: ::Array[FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Earning?]?, + employee_deductions: ::Array[FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction?]?, + employer_contributions: ::Array[FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution?]?, + gross_pay: FinchAPI::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?]?, + net_pay: FinchAPI::Money?, + payment_method: FinchAPI::Sandbox::PaymentCreateParams::PayStatement::payment_method?, + taxes: ::Array[FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Tax?]?, total_hours: Float?, - type: FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::type_? + type: FinchAPI::Sandbox::PaymentCreateParams::PayStatement::type_? } class PayStatement < FinchAPI::Internal::Type::BaseModel - attr_accessor earnings: ::Array[FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning?]? + attr_accessor earnings: ::Array[FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Earning?]? - attr_accessor employee_deductions: ::Array[FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction?]? + attr_accessor employee_deductions: ::Array[FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction?]? - attr_accessor employer_contributions: ::Array[FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution?]? + attr_accessor employer_contributions: ::Array[FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution?]? - attr_accessor gross_pay: FinchAPI::Models::Money? + attr_accessor gross_pay: FinchAPI::Money? attr_reader individual_id: String? def individual_id=: (String) -> String - attr_accessor net_pay: FinchAPI::Models::Money? + attr_accessor net_pay: FinchAPI::Money? - attr_accessor payment_method: FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::payment_method? + attr_accessor payment_method: FinchAPI::Sandbox::PaymentCreateParams::PayStatement::payment_method? - attr_accessor taxes: ::Array[FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax?]? + attr_accessor taxes: ::Array[FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Tax?]? attr_accessor total_hours: Float? - attr_accessor type: FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::type_? + attr_accessor type: FinchAPI::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?, + ?earnings: ::Array[FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Earning?]?, + ?employee_deductions: ::Array[FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction?]?, + ?employer_contributions: ::Array[FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution?]?, + ?gross_pay: FinchAPI::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?]?, + ?net_pay: FinchAPI::Money?, + ?payment_method: FinchAPI::Sandbox::PaymentCreateParams::PayStatement::payment_method?, + ?taxes: ::Array[FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Tax?]?, ?total_hours: Float?, - ?type: FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::type_? + ?type: FinchAPI::Sandbox::PaymentCreateParams::PayStatement::type_? ) -> void - def to_hash: -> FinchAPI::Models::Sandbox::PaymentCreateParams::pay_statement - type earning = { amount: Integer?, - attributes: FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Attributes?, + attributes: FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Earning::Attributes?, currency: String?, hours: Float?, name: String?, - type: FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::type_? + type: FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Earning::type_? } class Earning < FinchAPI::Internal::Type::BaseModel attr_accessor amount: Integer? - attr_accessor attributes: FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Attributes? + attr_accessor attributes: FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Earning::Attributes? attr_accessor currency: String? @@ -109,47 +105,41 @@ module FinchAPI attr_accessor name: String? - attr_accessor type: FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::type_? + attr_accessor type: FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Earning::type_? def initialize: ( ?amount: Integer?, - ?attributes: FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Attributes?, + ?attributes: FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Earning::Attributes?, ?currency: String?, ?hours: Float?, ?name: String?, - ?type: FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::type_? + ?type: FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Earning::type_? ) -> void - def to_hash: -> FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::earning - type attributes = { - metadata: FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Attributes::Metadata + metadata: FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Earning::Attributes::Metadata } class Attributes < FinchAPI::Internal::Type::BaseModel - attr_reader metadata: FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Attributes::Metadata? + attr_reader metadata: FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Earning::Attributes::Metadata? def metadata=: ( - FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Attributes::Metadata - ) -> FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Attributes::Metadata + FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Earning::Attributes::Metadata + ) -> FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Earning::Attributes::Metadata def initialize: ( - ?metadata: FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Attributes::Metadata + ?metadata: FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Earning::Attributes::Metadata ) -> void - def to_hash: -> FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::attributes - - type metadata = { metadata: ::Hash[Symbol, top] } + type metadata = { metadata: ::Hash[Symbol, top?] } class Metadata < FinchAPI::Internal::Type::BaseModel - attr_reader metadata: ::Hash[Symbol, top]? + attr_reader metadata: ::Hash[Symbol, top?]? - def metadata=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top] + def metadata=: (::Hash[Symbol, top?]) -> ::Hash[Symbol, top?] - def initialize: (?metadata: ::Hash[Symbol, top]) -> void - - def to_hash: -> FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Attributes::metadata + def initialize: (?metadata: ::Hash[Symbol, top?]) -> void end end @@ -185,14 +175,14 @@ module FinchAPI TYPE_1099: :"1099" OTHER: :other - def self?.values: -> ::Array[FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::type_] + def self?.values: -> ::Array[FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Earning::type_] end end type employee_deduction = { amount: Integer?, - attributes: FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Attributes?, + attributes: FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Attributes?, currency: String?, name: String?, pre_tax: bool?, @@ -202,7 +192,7 @@ module FinchAPI class EmployeeDeduction < FinchAPI::Internal::Type::BaseModel attr_accessor amount: Integer? - attr_accessor attributes: FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Attributes? + attr_accessor attributes: FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Attributes? attr_accessor currency: String? @@ -214,43 +204,37 @@ module FinchAPI def initialize: ( ?amount: Integer?, - ?attributes: FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Attributes?, + ?attributes: FinchAPI::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 - type attributes = { - metadata: FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Attributes::Metadata + metadata: FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Attributes::Metadata } class Attributes < FinchAPI::Internal::Type::BaseModel - attr_reader metadata: FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Attributes::Metadata? + attr_reader metadata: FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Attributes::Metadata? def metadata=: ( - FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Attributes::Metadata - ) -> FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Attributes::Metadata + FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Attributes::Metadata + ) -> FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Attributes::Metadata def initialize: ( - ?metadata: FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Attributes::Metadata + ?metadata: FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Attributes::Metadata ) -> void - def to_hash: -> FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::attributes - - type metadata = { metadata: ::Hash[Symbol, top] } + type metadata = { metadata: ::Hash[Symbol, top?] } class Metadata < FinchAPI::Internal::Type::BaseModel - attr_reader metadata: ::Hash[Symbol, top]? + attr_reader metadata: ::Hash[Symbol, top?]? - def metadata=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top] + def metadata=: (::Hash[Symbol, top?]) -> ::Hash[Symbol, top?] - def initialize: (?metadata: ::Hash[Symbol, top]) -> void - - def to_hash: -> FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Attributes::metadata + def initialize: (?metadata: ::Hash[Symbol, top?]) -> void end end end @@ -258,7 +242,7 @@ module FinchAPI type employer_contribution = { amount: Integer?, - attributes: FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Attributes?, + attributes: FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Attributes?, currency: String?, name: String?, type: FinchAPI::Models::HRIS::benefit_type? @@ -267,7 +251,7 @@ module FinchAPI class EmployerContribution < FinchAPI::Internal::Type::BaseModel attr_accessor amount: Integer? - attr_accessor attributes: FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Attributes? + attr_accessor attributes: FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Attributes? attr_accessor currency: String? @@ -277,42 +261,36 @@ module FinchAPI def initialize: ( ?amount: Integer?, - ?attributes: FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Attributes?, + ?attributes: FinchAPI::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 - type attributes = { - metadata: FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Attributes::Metadata + metadata: FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Attributes::Metadata } class Attributes < FinchAPI::Internal::Type::BaseModel - attr_reader metadata: FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Attributes::Metadata? + attr_reader metadata: FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Attributes::Metadata? def metadata=: ( - FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Attributes::Metadata - ) -> FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Attributes::Metadata + FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Attributes::Metadata + ) -> FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Attributes::Metadata def initialize: ( - ?metadata: FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Attributes::Metadata + ?metadata: FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Attributes::Metadata ) -> void - def to_hash: -> FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::attributes - - type metadata = { metadata: ::Hash[Symbol, top] } + type metadata = { metadata: ::Hash[Symbol, top?] } class Metadata < FinchAPI::Internal::Type::BaseModel - attr_reader metadata: ::Hash[Symbol, top]? - - def metadata=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top] + attr_reader metadata: ::Hash[Symbol, top?]? - def initialize: (?metadata: ::Hash[Symbol, top]) -> void + def metadata=: (::Hash[Symbol, top?]) -> ::Hash[Symbol, top?] - def to_hash: -> FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Attributes::metadata + def initialize: (?metadata: ::Hash[Symbol, top?]) -> void end end end @@ -325,23 +303,23 @@ module FinchAPI CHECK: :check DIRECT_DEPOSIT: :direct_deposit - def self?.values: -> ::Array[FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::payment_method] + def self?.values: -> ::Array[FinchAPI::Sandbox::PaymentCreateParams::PayStatement::payment_method] end type tax = { amount: Integer?, - attributes: FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::Attributes?, + attributes: FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Tax::Attributes?, currency: String?, employer: bool?, name: String?, - type: FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::type_? + type: FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Tax::type_? } class Tax < FinchAPI::Internal::Type::BaseModel attr_accessor amount: Integer? - attr_accessor attributes: FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::Attributes? + attr_accessor attributes: FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Tax::Attributes? attr_accessor currency: String? @@ -349,47 +327,41 @@ module FinchAPI attr_accessor name: String? - attr_accessor type: FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::type_? + attr_accessor type: FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Tax::type_? def initialize: ( ?amount: Integer?, - ?attributes: FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::Attributes?, + ?attributes: FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Tax::Attributes?, ?currency: String?, ?employer: bool?, ?name: String?, - ?type: FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::type_? + ?type: FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Tax::type_? ) -> void - def to_hash: -> FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::tax - type attributes = { - metadata: FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::Attributes::Metadata + metadata: FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Tax::Attributes::Metadata } class Attributes < FinchAPI::Internal::Type::BaseModel - attr_reader metadata: FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::Attributes::Metadata? + attr_reader metadata: FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Tax::Attributes::Metadata? def metadata=: ( - FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::Attributes::Metadata - ) -> FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::Attributes::Metadata + FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Tax::Attributes::Metadata + ) -> FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Tax::Attributes::Metadata def initialize: ( - ?metadata: FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::Attributes::Metadata + ?metadata: FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Tax::Attributes::Metadata ) -> void - def to_hash: -> FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::attributes - - type metadata = { metadata: ::Hash[Symbol, top] } + type metadata = { metadata: ::Hash[Symbol, top?] } class Metadata < FinchAPI::Internal::Type::BaseModel - attr_reader metadata: ::Hash[Symbol, top]? - - def metadata=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top] + attr_reader metadata: ::Hash[Symbol, top?]? - def initialize: (?metadata: ::Hash[Symbol, top]) -> void + def metadata=: (::Hash[Symbol, top?]) -> ::Hash[Symbol, top?] - def to_hash: -> FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::Attributes::metadata + def initialize: (?metadata: ::Hash[Symbol, top?]) -> void end end @@ -403,7 +375,7 @@ module FinchAPI LOCAL: :local FICA: :fica - def self?.values: -> ::Array[FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::type_] + def self?.values: -> ::Array[FinchAPI::Sandbox::PaymentCreateParams::PayStatement::Tax::type_] end end @@ -416,7 +388,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::Sandbox::PaymentCreateParams::PayStatement::type_] end end end diff --git a/sig/finch_api/models/sandbox/payment_create_response.rbs b/sig/finch_api/models/sandbox/payment_create_response.rbs index 9098cefb..cd6bbfdb 100644 --- a/sig/finch_api/models/sandbox/payment_create_response.rbs +++ b/sig/finch_api/models/sandbox/payment_create_response.rbs @@ -9,8 +9,6 @@ module FinchAPI attr_accessor payment_id: String def initialize: (pay_date: String, payment_id: String) -> void - - def to_hash: -> FinchAPI::Models::Sandbox::payment_create_response end end end diff --git a/sig/finch_api/models/webhook_event.rbs b/sig/finch_api/models/webhook_event.rbs index 1cfc1fc0..eac400a5 100644 --- a/sig/finch_api/models/webhook_event.rbs +++ b/sig/finch_api/models/webhook_event.rbs @@ -1,19 +1,19 @@ module FinchAPI module Models type webhook_event = - FinchAPI::Models::AccountUpdateEvent - | FinchAPI::Models::CompanyEvent - | FinchAPI::Models::JobCompletionEvent - | FinchAPI::Models::DirectoryEvent - | FinchAPI::Models::EmploymentEvent - | FinchAPI::Models::IndividualEvent - | FinchAPI::Models::PaymentEvent - | FinchAPI::Models::PayStatementEvent + FinchAPI::AccountUpdateEvent + | FinchAPI::CompanyEvent + | FinchAPI::JobCompletionEvent + | FinchAPI::DirectoryEvent + | FinchAPI::EmploymentEvent + | FinchAPI::IndividualEvent + | FinchAPI::PaymentEvent + | FinchAPI::PayStatementEvent module WebhookEvent extend FinchAPI::Internal::Type::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: -> ::Array[FinchAPI::Models::webhook_event] end end end diff --git a/sig/finch_api/request_options.rbs b/sig/finch_api/request_options.rbs index 8f2a8ade..868a58cb 100644 --- a/sig/finch_api/request_options.rbs +++ b/sig/finch_api/request_options.rbs @@ -13,7 +13,7 @@ module FinchAPI } class RequestOptions < FinchAPI::Internal::Type::BaseModel - def self.validate!: (self | ::Hash[Symbol, top] opts) -> void + def self.validate!: (FinchAPI::request_opts opts) -> void attr_accessor idempotency_key: String? diff --git a/sig/finch_api/resources/access_tokens.rbs b/sig/finch_api/resources/access_tokens.rbs index a7a785ef..a5c143c4 100644 --- a/sig/finch_api/resources/access_tokens.rbs +++ b/sig/finch_api/resources/access_tokens.rbs @@ -7,7 +7,7 @@ module FinchAPI ?client_secret: String, ?redirect_uri: String, ?request_options: FinchAPI::request_opts - ) -> FinchAPI::Models::CreateAccessTokenResponse + ) -> FinchAPI::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 71434068..b6b3d1f8 100644 --- a/sig/finch_api/resources/account.rbs +++ b/sig/finch_api/resources/account.rbs @@ -3,11 +3,11 @@ module FinchAPI class Account def disconnect: ( ?request_options: FinchAPI::request_opts - ) -> FinchAPI::Models::DisconnectResponse + ) -> FinchAPI::DisconnectResponse def introspect: ( ?request_options: FinchAPI::request_opts - ) -> FinchAPI::Models::Introspection + ) -> FinchAPI::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 3b43e61a..2456ca66 100644 --- a/sig/finch_api/resources/connect/sessions.rbs +++ b/sig/finch_api/resources/connect/sessions.rbs @@ -5,9 +5,9 @@ module FinchAPI def new: ( customer_id: String, customer_name: String, - products: ::Array[FinchAPI::Models::Connect::SessionNewParams::product], + products: ::Array[FinchAPI::Connect::SessionNewParams::product], ?customer_email: String?, - ?integration: FinchAPI::Models::Connect::SessionNewParams::Integration?, + ?integration: FinchAPI::Connect::SessionNewParams::Integration?, ?manual: bool?, ?minutes_to_expire: Float?, ?redirect_uri: String?, @@ -18,7 +18,7 @@ module FinchAPI def reauthenticate: ( connection_id: String, ?minutes_to_expire: Integer?, - ?products: ::Array[FinchAPI::Models::Connect::SessionReauthenticateParams::product]?, + ?products: ::Array[FinchAPI::Connect::SessionReauthenticateParams::product]?, ?redirect_uri: String?, ?request_options: FinchAPI::request_opts ) -> FinchAPI::Models::Connect::SessionReauthenticateResponse diff --git a/sig/finch_api/resources/hris/benefits.rbs b/sig/finch_api/resources/hris/benefits.rbs index 59133348..997e787d 100644 --- a/sig/finch_api/resources/hris/benefits.rbs +++ b/sig/finch_api/resources/hris/benefits.rbs @@ -5,27 +5,27 @@ module FinchAPI attr_reader individuals: FinchAPI::Resources::HRIS::Benefits::Individuals def create: ( - ?company_contribution: FinchAPI::Models::HRIS::BenefitCreateParams::CompanyContribution?, + ?company_contribution: FinchAPI::HRIS::BenefitCreateParams::CompanyContribution?, ?description: String, ?frequency: FinchAPI::Models::HRIS::benefit_frequency?, ?type: FinchAPI::Models::HRIS::benefit_type?, ?request_options: FinchAPI::request_opts - ) -> FinchAPI::Models::HRIS::CreateCompanyBenefitsResponse + ) -> FinchAPI::HRIS::CreateCompanyBenefitsResponse def retrieve: ( String benefit_id, ?request_options: FinchAPI::request_opts - ) -> FinchAPI::Models::HRIS::CompanyBenefit + ) -> FinchAPI::HRIS::CompanyBenefit def update: ( String benefit_id, ?description: String, ?request_options: FinchAPI::request_opts - ) -> FinchAPI::Models::HRIS::UpdateCompanyBenefitResponse + ) -> FinchAPI::HRIS::UpdateCompanyBenefitResponse def list: ( ?request_options: FinchAPI::request_opts - ) -> FinchAPI::Internal::SinglePage[FinchAPI::Models::HRIS::CompanyBenefit] + ) -> FinchAPI::Internal::SinglePage[FinchAPI::HRIS::CompanyBenefit] def list_supported_benefits: ( ?request_options: FinchAPI::request_opts diff --git a/sig/finch_api/resources/hris/benefits/individuals.rbs b/sig/finch_api/resources/hris/benefits/individuals.rbs index f3ca6b9a..a8349445 100644 --- a/sig/finch_api/resources/hris/benefits/individuals.rbs +++ b/sig/finch_api/resources/hris/benefits/individuals.rbs @@ -5,9 +5,9 @@ module FinchAPI class Individuals def enroll_many: ( String benefit_id, - ?individuals: ::Array[FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual], + ?individuals: ::Array[FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual], ?request_options: FinchAPI::request_opts - ) -> FinchAPI::Models::HRIS::Benefits::EnrolledIndividualBenefitResponse + ) -> FinchAPI::HRIS::Benefits::EnrolledIndividualBenefitResponse def enrolled_ids: ( String benefit_id, @@ -18,13 +18,13 @@ module FinchAPI String benefit_id, ?individual_ids: String, ?request_options: FinchAPI::request_opts - ) -> FinchAPI::Internal::SinglePage[FinchAPI::Models::HRIS::Benefits::IndividualBenefit] + ) -> FinchAPI::Internal::SinglePage[FinchAPI::HRIS::Benefits::IndividualBenefit] def unenroll_many: ( String benefit_id, ?individual_ids: ::Array[String], ?request_options: FinchAPI::request_opts - ) -> FinchAPI::Models::HRIS::Benefits::UnenrolledIndividualBenefitResponse + ) -> FinchAPI::HRIS::Benefits::UnenrolledIndividualBenefitResponse 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 2e3ece32..faeb18ce 100644 --- a/sig/finch_api/resources/hris/company.rbs +++ b/sig/finch_api/resources/hris/company.rbs @@ -6,7 +6,7 @@ module FinchAPI def retrieve: ( ?request_options: FinchAPI::request_opts - ) -> FinchAPI::Models::HRIS::HRISCompany + ) -> FinchAPI::HRIS::HRISCompany def initialize: (client: FinchAPI::Client) -> void end diff --git a/sig/finch_api/resources/hris/company/pay_statement_item.rbs b/sig/finch_api/resources/hris/company/pay_statement_item.rbs index 00da5c7b..f7dd9a01 100644 --- a/sig/finch_api/resources/hris/company/pay_statement_item.rbs +++ b/sig/finch_api/resources/hris/company/pay_statement_item.rbs @@ -6,7 +6,7 @@ module FinchAPI attr_reader rules: FinchAPI::Resources::HRIS::Company::PayStatementItem::Rules def list: ( - ?categories: ::Array[FinchAPI::Models::HRIS::Company::PayStatementItemListParams::category], + ?categories: ::Array[FinchAPI::HRIS::Company::PayStatementItemListParams::category], ?end_date: Date, ?name: String, ?start_date: Date, diff --git a/sig/finch_api/resources/hris/company/pay_statement_item/rules.rbs b/sig/finch_api/resources/hris/company/pay_statement_item/rules.rbs index aca0f0ba..1d171d88 100644 --- a/sig/finch_api/resources/hris/company/pay_statement_item/rules.rbs +++ b/sig/finch_api/resources/hris/company/pay_statement_item/rules.rbs @@ -5,8 +5,8 @@ module FinchAPI class PayStatementItem class Rules def create: ( - ?attributes: FinchAPI::Models::HRIS::Company::PayStatementItem::RuleCreateParams::Attributes, - ?conditions: ::Array[FinchAPI::Models::HRIS::Company::PayStatementItem::RuleCreateParams::Condition], + ?attributes: FinchAPI::HRIS::Company::PayStatementItem::RuleCreateParams::Attributes, + ?conditions: ::Array[FinchAPI::HRIS::Company::PayStatementItem::RuleCreateParams::Condition], ?effective_end_date: String?, ?effective_start_date: String?, ?entity_type: FinchAPI::Models::HRIS::Company::PayStatementItem::RuleCreateParams::entity_type, diff --git a/sig/finch_api/resources/hris/directory.rbs b/sig/finch_api/resources/hris/directory.rbs index bd924689..448363a4 100644 --- a/sig/finch_api/resources/hris/directory.rbs +++ b/sig/finch_api/resources/hris/directory.rbs @@ -6,7 +6,7 @@ module FinchAPI ?limit: Integer, ?offset: Integer, ?request_options: FinchAPI::request_opts - ) -> FinchAPI::Internal::IndividualsPage[FinchAPI::Models::HRIS::IndividualInDirectory] + ) -> FinchAPI::Internal::IndividualsPage[FinchAPI::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 f760d678..b294de77 100644 --- a/sig/finch_api/resources/hris/documents.rbs +++ b/sig/finch_api/resources/hris/documents.rbs @@ -6,7 +6,7 @@ module FinchAPI ?individual_ids: ::Array[String], ?limit: Integer, ?offset: Integer, - ?types: ::Array[FinchAPI::Models::HRIS::DocumentListParams::type_], + ?types: ::Array[FinchAPI::HRIS::DocumentListParams::type_], ?request_options: FinchAPI::request_opts ) -> FinchAPI::Models::HRIS::DocumentListResponse diff --git a/sig/finch_api/resources/hris/employments.rbs b/sig/finch_api/resources/hris/employments.rbs index 78e42fb5..69df120c 100644 --- a/sig/finch_api/resources/hris/employments.rbs +++ b/sig/finch_api/resources/hris/employments.rbs @@ -3,9 +3,9 @@ module FinchAPI class HRIS class Employments def retrieve_many: ( - requests: ::Array[FinchAPI::Models::HRIS::EmploymentRetrieveManyParams::Request], + requests: ::Array[FinchAPI::HRIS::EmploymentRetrieveManyParams::Request], ?request_options: FinchAPI::request_opts - ) -> FinchAPI::Internal::ResponsesPage[FinchAPI::Models::HRIS::EmploymentDataResponse] + ) -> FinchAPI::Internal::ResponsesPage[FinchAPI::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 8cda1a67..d1425ebc 100644 --- a/sig/finch_api/resources/hris/individuals.rbs +++ b/sig/finch_api/resources/hris/individuals.rbs @@ -3,10 +3,10 @@ module FinchAPI class HRIS class Individuals def retrieve_many: ( - ?options: FinchAPI::Models::HRIS::IndividualRetrieveManyParams::Options?, - ?requests: ::Array[FinchAPI::Models::HRIS::IndividualRetrieveManyParams::Request], + ?options: FinchAPI::HRIS::IndividualRetrieveManyParams::Options?, + ?requests: ::Array[FinchAPI::HRIS::IndividualRetrieveManyParams::Request], ?request_options: FinchAPI::request_opts - ) -> FinchAPI::Internal::ResponsesPage[FinchAPI::Models::HRIS::IndividualResponse] + ) -> FinchAPI::Internal::ResponsesPage[FinchAPI::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 2f31295d..2485acca 100644 --- a/sig/finch_api/resources/hris/pay_statements.rbs +++ b/sig/finch_api/resources/hris/pay_statements.rbs @@ -3,9 +3,9 @@ module FinchAPI class HRIS class PayStatements def retrieve_many: ( - requests: ::Array[FinchAPI::Models::HRIS::PayStatementRetrieveManyParams::Request], + requests: ::Array[FinchAPI::HRIS::PayStatementRetrieveManyParams::Request], ?request_options: FinchAPI::request_opts - ) -> FinchAPI::Internal::ResponsesPage[FinchAPI::Models::HRIS::PayStatementResponse] + ) -> FinchAPI::Internal::ResponsesPage[FinchAPI::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 b1b192a3..d3a295af 100644 --- a/sig/finch_api/resources/hris/payments.rbs +++ b/sig/finch_api/resources/hris/payments.rbs @@ -6,7 +6,7 @@ module FinchAPI end_date: Date, start_date: Date, ?request_options: FinchAPI::request_opts - ) -> FinchAPI::Internal::SinglePage[FinchAPI::Models::HRIS::Payment] + ) -> FinchAPI::Internal::SinglePage[FinchAPI::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 21a263c6..f23f755c 100644 --- a/sig/finch_api/resources/jobs/automated.rbs +++ b/sig/finch_api/resources/jobs/automated.rbs @@ -4,14 +4,14 @@ module FinchAPI class Automated def create: ( type: FinchAPI::Models::Jobs::AutomatedCreateParams::type_, - params: FinchAPI::Models::Jobs::AutomatedCreateParams::Params, + params: FinchAPI::Jobs::AutomatedCreateParams::Params, ?request_options: FinchAPI::request_opts ) -> FinchAPI::Models::Jobs::AutomatedCreateResponse def retrieve: ( String job_id, ?request_options: FinchAPI::request_opts - ) -> FinchAPI::Models::Jobs::AutomatedAsyncJob + ) -> FinchAPI::Jobs::AutomatedAsyncJob def list: ( ?limit: Integer, diff --git a/sig/finch_api/resources/jobs/manual.rbs b/sig/finch_api/resources/jobs/manual.rbs index dd060893..41f4515e 100644 --- a/sig/finch_api/resources/jobs/manual.rbs +++ b/sig/finch_api/resources/jobs/manual.rbs @@ -5,7 +5,7 @@ module FinchAPI def retrieve: ( String job_id, ?request_options: FinchAPI::request_opts - ) -> FinchAPI::Models::Jobs::ManualAsyncJob + ) -> FinchAPI::Jobs::ManualAsyncJob def initialize: (client: FinchAPI::Client) -> void end diff --git a/sig/finch_api/resources/providers.rbs b/sig/finch_api/resources/providers.rbs index b1481a69..6c4dfd04 100644 --- a/sig/finch_api/resources/providers.rbs +++ b/sig/finch_api/resources/providers.rbs @@ -3,7 +3,7 @@ module FinchAPI class Providers def list: ( ?request_options: FinchAPI::request_opts - ) -> FinchAPI::Internal::SinglePage[FinchAPI::Models::Provider] + ) -> FinchAPI::Internal::SinglePage[FinchAPI::Provider] 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 61ba0f8b..e7fb43b2 100644 --- a/sig/finch_api/resources/sandbox/company.rbs +++ b/sig/finch_api/resources/sandbox/company.rbs @@ -3,12 +3,12 @@ module FinchAPI class Sandbox class Company def update: ( - accounts: ::Array[FinchAPI::Models::Sandbox::CompanyUpdateParams::Account]?, - departments: ::Array[FinchAPI::Models::Sandbox::CompanyUpdateParams::Department?]?, + accounts: ::Array[FinchAPI::Sandbox::CompanyUpdateParams::Account]?, + departments: ::Array[FinchAPI::Sandbox::CompanyUpdateParams::Department?]?, ein: String?, - entity: FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity?, + entity: FinchAPI::Sandbox::CompanyUpdateParams::Entity?, legal_name: String?, - locations: ::Array[FinchAPI::Models::Location?]?, + locations: ::Array[FinchAPI::Location?]?, primary_email: String?, primary_phone_number: String?, ?request_options: FinchAPI::request_opts diff --git a/sig/finch_api/resources/sandbox/directory.rbs b/sig/finch_api/resources/sandbox/directory.rbs index e2a5a437..327356d7 100644 --- a/sig/finch_api/resources/sandbox/directory.rbs +++ b/sig/finch_api/resources/sandbox/directory.rbs @@ -3,7 +3,7 @@ module FinchAPI class Sandbox class Directory def create: ( - ?body: ::Array[FinchAPI::Models::Sandbox::DirectoryCreateParams::Body], + ?body: ::Array[FinchAPI::Sandbox::DirectoryCreateParams::Body], ?request_options: FinchAPI::request_opts ) -> FinchAPI::Models::Sandbox::directory_create_response diff --git a/sig/finch_api/resources/sandbox/employment.rbs b/sig/finch_api/resources/sandbox/employment.rbs index fa8f2880..a5bdcd9c 100644 --- a/sig/finch_api/resources/sandbox/employment.rbs +++ b/sig/finch_api/resources/sandbox/employment.rbs @@ -5,19 +5,19 @@ module FinchAPI 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?, + ?custom_fields: ::Array[FinchAPI::Sandbox::EmploymentUpdateParams::CustomField], + ?department: FinchAPI::Sandbox::EmploymentUpdateParams::Department?, + ?employment: FinchAPI::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?]?, + ?income: FinchAPI::Income?, + ?income_history: ::Array[FinchAPI::Income?]?, ?is_active: bool?, ?last_name: String?, ?latest_rehire_date: String?, - ?location: FinchAPI::Models::Location?, - ?manager: FinchAPI::Models::Sandbox::EmploymentUpdateParams::Manager?, + ?location: FinchAPI::Location?, + ?manager: FinchAPI::Sandbox::EmploymentUpdateParams::Manager?, ?middle_name: String?, ?source_id: String, ?start_date: String?, diff --git a/sig/finch_api/resources/sandbox/individual.rbs b/sig/finch_api/resources/sandbox/individual.rbs index 76b23fa1..77d42400 100644 --- a/sig/finch_api/resources/sandbox/individual.rbs +++ b/sig/finch_api/resources/sandbox/individual.rbs @@ -5,16 +5,16 @@ module FinchAPI def update: ( String individual_id, ?dob: String?, - ?emails: ::Array[FinchAPI::Models::Sandbox::IndividualUpdateParams::Email]?, + ?emails: ::Array[FinchAPI::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?]?, + ?phone_numbers: ::Array[FinchAPI::Sandbox::IndividualUpdateParams::PhoneNumber?]?, ?preferred_name: String?, - ?residence: FinchAPI::Models::Location?, + ?residence: FinchAPI::Location?, ?ssn: String?, ?request_options: FinchAPI::request_opts ) -> FinchAPI::Models::Sandbox::IndividualUpdateResponse diff --git a/sig/finch_api/resources/sandbox/jobs/configuration.rbs b/sig/finch_api/resources/sandbox/jobs/configuration.rbs index 23b6afdc..5deb4949 100644 --- a/sig/finch_api/resources/sandbox/jobs/configuration.rbs +++ b/sig/finch_api/resources/sandbox/jobs/configuration.rbs @@ -11,7 +11,7 @@ module FinchAPI 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 + ) -> FinchAPI::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 6c30fa7d..c22a1b32 100644 --- a/sig/finch_api/resources/sandbox/payment.rbs +++ b/sig/finch_api/resources/sandbox/payment.rbs @@ -4,7 +4,7 @@ module FinchAPI class Payment def create: ( ?end_date: String, - ?pay_statements: ::Array[FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement], + ?pay_statements: ::Array[FinchAPI::Sandbox::PaymentCreateParams::PayStatement], ?start_date: String, ?request_options: FinchAPI::request_opts ) -> FinchAPI::Models::Sandbox::PaymentCreateResponse diff --git a/test/finch_api/internal/util_test.rb b/test/finch_api/internal/util_test.rb index 065bfa53..9f7c623c 100644 --- a/test/finch_api/internal/util_test.rb +++ b/test/finch_api/internal/util_test.rb @@ -172,6 +172,22 @@ def test_json_content end end end + + def test_jsonl_content + cases = { + "application/x-ndjson" => true, + "application/x-ldjson" => true, + "application/jsonl" => true, + "application/x-jsonl" => true, + "application/json" => false, + "application/vnd.api+json" => false + } + cases.each do |header, verdict| + assert_pattern do + FinchAPI::Internal::Util::JSONL_CONTENT.match?(header) => ^verdict + end + end + end end class FinchAPI::Test::UtilFormDataEncodingTest < Minitest::Test diff --git a/test/finch_api/resources/access_tokens_test.rb b/test/finch_api/resources/access_tokens_test.rb index 326b3b93..2f4f39e1 100644 --- a/test/finch_api/resources/access_tokens_test.rb +++ b/test/finch_api/resources/access_tokens_test.rb @@ -7,17 +7,17 @@ def test_create_required_params response = @finch.access_tokens.create(code: "") assert_pattern do - response => FinchAPI::Models::CreateAccessTokenResponse + response => FinchAPI::CreateAccessTokenResponse end assert_pattern do response => { access_token: String, account_id: String, - client_type: FinchAPI::Models::CreateAccessTokenResponse::ClientType, + client_type: FinchAPI::CreateAccessTokenResponse::ClientType, company_id: String, connection_id: String, - connection_type: FinchAPI::Models::CreateAccessTokenResponse::ConnectionType, + connection_type: FinchAPI::CreateAccessTokenResponse::ConnectionType, products: ^(FinchAPI::Internal::Type::ArrayOf[String]), provider_id: String, customer_id: String | nil, diff --git a/test/finch_api/resources/account_test.rb b/test/finch_api/resources/account_test.rb index 730f24f5..f3a15591 100644 --- a/test/finch_api/resources/account_test.rb +++ b/test/finch_api/resources/account_test.rb @@ -7,7 +7,7 @@ def test_disconnect response = @finch.account.disconnect assert_pattern do - response => FinchAPI::Models::DisconnectResponse + response => FinchAPI::DisconnectResponse end assert_pattern do @@ -21,20 +21,20 @@ def test_introspect response = @finch.account.introspect assert_pattern do - response => FinchAPI::Models::Introspection + response => FinchAPI::Introspection end assert_pattern do response => { id: String, account_id: String, - authentication_methods: ^(FinchAPI::Internal::Type::ArrayOf[FinchAPI::Models::Introspection::AuthenticationMethod]), + authentication_methods: ^(FinchAPI::Internal::Type::ArrayOf[FinchAPI::Introspection::AuthenticationMethod]), client_id: String, - client_type: FinchAPI::Models::Introspection::ClientType, + client_type: FinchAPI::Introspection::ClientType, company_id: String, connection_id: String, - connection_status: FinchAPI::Models::Introspection::ConnectionStatus, - connection_type: FinchAPI::Models::Introspection::ConnectionType, + connection_status: FinchAPI::Introspection::ConnectionStatus, + connection_type: FinchAPI::Introspection::ConnectionType, customer_email: String | nil, customer_id: String | nil, customer_name: String | nil, diff --git a/test/finch_api/resources/hris/benefits/individuals_test.rb b/test/finch_api/resources/hris/benefits/individuals_test.rb index 2c9ea1db..b8b559d4 100644 --- a/test/finch_api/resources/hris/benefits/individuals_test.rb +++ b/test/finch_api/resources/hris/benefits/individuals_test.rb @@ -7,7 +7,7 @@ def test_enroll_many response = @finch.hris.benefits.individuals.enroll_many("benefit_id") assert_pattern do - response => FinchAPI::Models::HRIS::Benefits::EnrolledIndividualBenefitResponse + response => FinchAPI::HRIS::Benefits::EnrolledIndividualBenefitResponse end assert_pattern do @@ -43,12 +43,12 @@ def test_retrieve_many_benefits return if row.nil? assert_pattern do - row => FinchAPI::Models::HRIS::Benefits::IndividualBenefit + row => FinchAPI::HRIS::Benefits::IndividualBenefit end assert_pattern do row => { - body: FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body | nil, + body: FinchAPI::HRIS::Benefits::IndividualBenefit::Body | nil, code: Integer | nil, individual_id: String | nil } @@ -59,7 +59,7 @@ def test_unenroll_many response = @finch.hris.benefits.individuals.unenroll_many("benefit_id") assert_pattern do - response => FinchAPI::Models::HRIS::Benefits::UnenrolledIndividualBenefitResponse + response => FinchAPI::HRIS::Benefits::UnenrolledIndividualBenefitResponse end assert_pattern do diff --git a/test/finch_api/resources/hris/benefits_test.rb b/test/finch_api/resources/hris/benefits_test.rb index 78a50038..6cc85455 100644 --- a/test/finch_api/resources/hris/benefits_test.rb +++ b/test/finch_api/resources/hris/benefits_test.rb @@ -7,7 +7,7 @@ def test_create response = @finch.hris.benefits.create assert_pattern do - response => FinchAPI::Models::HRIS::CreateCompanyBenefitsResponse + response => FinchAPI::HRIS::CreateCompanyBenefitsResponse end assert_pattern do @@ -22,16 +22,16 @@ def test_retrieve response = @finch.hris.benefits.retrieve("benefit_id") assert_pattern do - response => FinchAPI::Models::HRIS::CompanyBenefit + response => FinchAPI::HRIS::CompanyBenefit end assert_pattern do response => { benefit_id: String, - company_contribution: FinchAPI::Models::HRIS::CompanyBenefit::CompanyContribution | nil, + company_contribution: FinchAPI::HRIS::CompanyBenefit::CompanyContribution | nil, description: String | nil, - frequency: FinchAPI::Models::HRIS::BenefitFrequency | nil, - type: FinchAPI::Models::HRIS::BenefitType | nil + frequency: FinchAPI::HRIS::BenefitFrequency | nil, + type: FinchAPI::HRIS::BenefitType | nil } end end @@ -40,7 +40,7 @@ def test_update response = @finch.hris.benefits.update("benefit_id") assert_pattern do - response => FinchAPI::Models::HRIS::UpdateCompanyBenefitResponse + response => FinchAPI::HRIS::UpdateCompanyBenefitResponse end assert_pattern do @@ -62,16 +62,16 @@ def test_list return if row.nil? assert_pattern do - row => FinchAPI::Models::HRIS::CompanyBenefit + row => FinchAPI::HRIS::CompanyBenefit end assert_pattern do row => { benefit_id: String, - company_contribution: FinchAPI::Models::HRIS::CompanyBenefit::CompanyContribution | nil, + company_contribution: FinchAPI::HRIS::CompanyBenefit::CompanyContribution | nil, description: String | nil, - frequency: FinchAPI::Models::HRIS::BenefitFrequency | nil, - type: FinchAPI::Models::HRIS::BenefitType | nil + frequency: FinchAPI::HRIS::BenefitFrequency | nil, + type: FinchAPI::HRIS::BenefitType | nil } end end @@ -97,7 +97,8 @@ def test_list_supported_benefits company_contribution: ^(FinchAPI::Internal::Type::ArrayOf[enum: FinchAPI::Models::HRIS::BenefitListSupportedBenefitsResponse::CompanyContribution, nil?: true]) | nil, description: String | nil, employee_deduction: ^(FinchAPI::Internal::Type::ArrayOf[enum: FinchAPI::Models::HRIS::BenefitListSupportedBenefitsResponse::EmployeeDeduction, nil?: true]) | nil, - frequencies: ^(FinchAPI::Internal::Type::ArrayOf[enum: FinchAPI::Models::HRIS::BenefitFrequency, nil?: true]) | nil, + frequencies: ^(FinchAPI::Internal::Type::ArrayOf[enum: FinchAPI::HRIS::BenefitFrequency, + nil?: true]) | nil, hsa_contribution_limit: ^(FinchAPI::Internal::Type::ArrayOf[enum: FinchAPI::Models::HRIS::BenefitListSupportedBenefitsResponse::HsaContributionLimit, nil?: true]) | nil } end diff --git a/test/finch_api/resources/hris/company_test.rb b/test/finch_api/resources/hris/company_test.rb index 5446faa6..0c0157c4 100644 --- a/test/finch_api/resources/hris/company_test.rb +++ b/test/finch_api/resources/hris/company_test.rb @@ -7,18 +7,19 @@ def test_retrieve response = @finch.hris.company.retrieve assert_pattern do - response => FinchAPI::Models::HRIS::HRISCompany + response => FinchAPI::HRIS::HRISCompany end assert_pattern do response => { id: String, - accounts: ^(FinchAPI::Internal::Type::ArrayOf[FinchAPI::Models::HRIS::HRISCompany::Account]) | nil, - departments: ^(FinchAPI::Internal::Type::ArrayOf[FinchAPI::Models::HRIS::HRISCompany::Department, nil?: true]) | nil, + accounts: ^(FinchAPI::Internal::Type::ArrayOf[FinchAPI::HRIS::HRISCompany::Account]) | nil, + departments: ^(FinchAPI::Internal::Type::ArrayOf[FinchAPI::HRIS::HRISCompany::Department, + nil?: true]) | nil, ein: String | nil, - entity: FinchAPI::Models::HRIS::HRISCompany::Entity | nil, + entity: FinchAPI::HRIS::HRISCompany::Entity | nil, legal_name: String | nil, - locations: ^(FinchAPI::Internal::Type::ArrayOf[FinchAPI::Models::Location, nil?: true]) | nil, + locations: ^(FinchAPI::Internal::Type::ArrayOf[FinchAPI::Location, nil?: true]) | nil, primary_email: String | nil, primary_phone_number: String | nil } diff --git a/test/finch_api/resources/hris/directory_test.rb b/test/finch_api/resources/hris/directory_test.rb index e4699700..07b3310d 100644 --- a/test/finch_api/resources/hris/directory_test.rb +++ b/test/finch_api/resources/hris/directory_test.rb @@ -14,17 +14,17 @@ def test_list return if row.nil? assert_pattern do - row => FinchAPI::Models::HRIS::IndividualInDirectory + row => FinchAPI::HRIS::IndividualInDirectory end assert_pattern do row => { id: String, - department: FinchAPI::Models::HRIS::IndividualInDirectory::Department | nil, + department: FinchAPI::HRIS::IndividualInDirectory::Department | nil, first_name: String | nil, is_active: FinchAPI::Internal::Type::Boolean | nil, last_name: String | nil, - manager: FinchAPI::Models::HRIS::IndividualInDirectory::Manager | nil, + manager: FinchAPI::HRIS::IndividualInDirectory::Manager | nil, middle_name: String | nil } end @@ -41,17 +41,17 @@ def test_list_individuals return if row.nil? assert_pattern do - row => FinchAPI::Models::HRIS::IndividualInDirectory + row => FinchAPI::HRIS::IndividualInDirectory end assert_pattern do row => { id: String, - department: FinchAPI::Models::HRIS::IndividualInDirectory::Department | nil, + department: FinchAPI::HRIS::IndividualInDirectory::Department | nil, first_name: String | nil, is_active: FinchAPI::Internal::Type::Boolean | nil, last_name: String | nil, - manager: FinchAPI::Models::HRIS::IndividualInDirectory::Manager | nil, + manager: FinchAPI::HRIS::IndividualInDirectory::Manager | nil, middle_name: String | nil } end diff --git a/test/finch_api/resources/hris/documents_test.rb b/test/finch_api/resources/hris/documents_test.rb index 1214f1dc..1c00da1b 100644 --- a/test/finch_api/resources/hris/documents_test.rb +++ b/test/finch_api/resources/hris/documents_test.rb @@ -12,8 +12,8 @@ def test_list assert_pattern do response => { - documents: ^(FinchAPI::Internal::Type::ArrayOf[FinchAPI::Models::HRIS::DocumentResponse]), - paging: FinchAPI::Models::Paging + documents: ^(FinchAPI::Internal::Type::ArrayOf[FinchAPI::HRIS::DocumentResponse]), + paging: FinchAPI::Paging } end end @@ -27,15 +27,15 @@ def test_retreive assert_pattern do case response - in FinchAPI::Models::HRIS::W42020 - in FinchAPI::Models::HRIS::W42005 + in FinchAPI::HRIS::W42020 + in FinchAPI::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} + in {type: :w4_2020, data: FinchAPI::HRIS::W42020::Data | nil, year: Float | nil} + in {type: :w4_2005, data: FinchAPI::HRIS::W42005::Data | nil, year: Float | nil} end end end diff --git a/test/finch_api/resources/hris/employments_test.rb b/test/finch_api/resources/hris/employments_test.rb index 51b7e085..751995aa 100644 --- a/test/finch_api/resources/hris/employments_test.rb +++ b/test/finch_api/resources/hris/employments_test.rb @@ -14,14 +14,14 @@ def test_retrieve_many_required_params return if row.nil? assert_pattern do - row => FinchAPI::Models::HRIS::EmploymentDataResponse + row => FinchAPI::HRIS::EmploymentDataResponse end assert_pattern do row => { - body: FinchAPI::Models::HRIS::EmploymentData | nil, - code: Integer | nil, - individual_id: String | nil + body: FinchAPI::HRIS::EmploymentData, + code: Integer, + individual_id: String } end end diff --git a/test/finch_api/resources/hris/individuals_test.rb b/test/finch_api/resources/hris/individuals_test.rb index 37197cba..a568a197 100644 --- a/test/finch_api/resources/hris/individuals_test.rb +++ b/test/finch_api/resources/hris/individuals_test.rb @@ -14,12 +14,12 @@ def test_retrieve_many return if row.nil? assert_pattern do - row => FinchAPI::Models::HRIS::IndividualResponse + row => FinchAPI::HRIS::IndividualResponse end assert_pattern do row => { - body: FinchAPI::Models::HRIS::Individual, + body: FinchAPI::HRIS::Individual, code: Integer, individual_id: String } diff --git a/test/finch_api/resources/hris/pay_statements_test.rb b/test/finch_api/resources/hris/pay_statements_test.rb index bc1bbbe4..735fa76d 100644 --- a/test/finch_api/resources/hris/pay_statements_test.rb +++ b/test/finch_api/resources/hris/pay_statements_test.rb @@ -15,12 +15,12 @@ def test_retrieve_many_required_params return if row.nil? assert_pattern do - row => FinchAPI::Models::HRIS::PayStatementResponse + row => FinchAPI::HRIS::PayStatementResponse end assert_pattern do row => { - body: FinchAPI::Models::HRIS::PayStatementResponseBody | nil, + body: FinchAPI::HRIS::PayStatementResponseBody | nil, code: Integer | nil, payment_id: String | nil } diff --git a/test/finch_api/resources/hris/payments_test.rb b/test/finch_api/resources/hris/payments_test.rb index 09402c9e..fb27a74b 100644 --- a/test/finch_api/resources/hris/payments_test.rb +++ b/test/finch_api/resources/hris/payments_test.rb @@ -14,23 +14,23 @@ def test_list_required_params return if row.nil? assert_pattern do - row => FinchAPI::Models::HRIS::Payment + row => FinchAPI::HRIS::Payment end assert_pattern do row => { id: String | nil, - company_debit: FinchAPI::Models::Money | nil, + company_debit: FinchAPI::Money | nil, debit_date: String | nil, - employee_taxes: FinchAPI::Models::Money | nil, - employer_taxes: FinchAPI::Models::Money | nil, - gross_pay: FinchAPI::Models::Money | nil, + employee_taxes: FinchAPI::Money | nil, + employer_taxes: FinchAPI::Money | nil, + gross_pay: FinchAPI::Money | nil, individual_ids: ^(FinchAPI::Internal::Type::ArrayOf[String]) | nil, - net_pay: FinchAPI::Models::Money | nil, + net_pay: FinchAPI::Money | nil, pay_date: String | nil, - pay_frequencies: ^(FinchAPI::Internal::Type::ArrayOf[enum: FinchAPI::Models::HRIS::Payment::PayFrequency]) | nil, + pay_frequencies: ^(FinchAPI::Internal::Type::ArrayOf[enum: FinchAPI::HRIS::Payment::PayFrequency]) | nil, pay_group_ids: ^(FinchAPI::Internal::Type::ArrayOf[String]) | nil, - pay_period: FinchAPI::Models::HRIS::Payment::PayPeriod | nil + pay_period: FinchAPI::HRIS::Payment::PayPeriod | nil } end end diff --git a/test/finch_api/resources/jobs/automated_test.rb b/test/finch_api/resources/jobs/automated_test.rb index 9457e52f..4942aeee 100644 --- a/test/finch_api/resources/jobs/automated_test.rb +++ b/test/finch_api/resources/jobs/automated_test.rb @@ -25,7 +25,7 @@ def test_retrieve response = @finch.jobs.automated.retrieve("job_id") assert_pattern do - response => FinchAPI::Models::Jobs::AutomatedAsyncJob + response => FinchAPI::Jobs::AutomatedAsyncJob end assert_pattern do @@ -34,11 +34,11 @@ def test_retrieve created_at: Time, job_id: String, job_url: String, - params: FinchAPI::Models::Jobs::AutomatedAsyncJob::Params | nil, + params: FinchAPI::Jobs::AutomatedAsyncJob::Params | nil, scheduled_at: Time | nil, started_at: Time | nil, - status: FinchAPI::Models::Jobs::AutomatedAsyncJob::Status, - type: FinchAPI::Models::Jobs::AutomatedAsyncJob::Type + status: FinchAPI::Jobs::AutomatedAsyncJob::Status, + type: FinchAPI::Jobs::AutomatedAsyncJob::Type } end end @@ -52,7 +52,7 @@ def test_list assert_pattern do response => { - data: ^(FinchAPI::Internal::Type::ArrayOf[FinchAPI::Models::Jobs::AutomatedAsyncJob]), + data: ^(FinchAPI::Internal::Type::ArrayOf[FinchAPI::Jobs::AutomatedAsyncJob]), meta: FinchAPI::Models::Jobs::AutomatedListResponse::Meta } end diff --git a/test/finch_api/resources/jobs/manual_test.rb b/test/finch_api/resources/jobs/manual_test.rb index 2233c062..f59d4fbc 100644 --- a/test/finch_api/resources/jobs/manual_test.rb +++ b/test/finch_api/resources/jobs/manual_test.rb @@ -7,14 +7,14 @@ def test_retrieve response = @finch.jobs.manual.retrieve("job_id") assert_pattern do - response => FinchAPI::Models::Jobs::ManualAsyncJob + response => FinchAPI::Jobs::ManualAsyncJob end assert_pattern do response => { body: ^(FinchAPI::Internal::Type::ArrayOf[FinchAPI::Internal::Type::Unknown]) | nil, job_id: String, - status: FinchAPI::Models::Jobs::ManualAsyncJob::Status + status: FinchAPI::Jobs::ManualAsyncJob::Status } end end diff --git a/test/finch_api/resources/providers_test.rb b/test/finch_api/resources/providers_test.rb index f0b07ee2..42c03b10 100644 --- a/test/finch_api/resources/providers_test.rb +++ b/test/finch_api/resources/providers_test.rb @@ -14,13 +14,13 @@ def test_list return if row.nil? assert_pattern do - row => FinchAPI::Models::Provider + row => FinchAPI::Provider end assert_pattern do row => { id: String | nil, - authentication_methods: ^(FinchAPI::Internal::Type::ArrayOf[FinchAPI::Models::Provider::AuthenticationMethod]) | nil, + authentication_methods: ^(FinchAPI::Internal::Type::ArrayOf[FinchAPI::Provider::AuthenticationMethod]) | nil, beta: FinchAPI::Internal::Type::Boolean | nil, display_name: String | nil, icon: String | nil, diff --git a/test/finch_api/resources/sandbox/company_test.rb b/test/finch_api/resources/sandbox/company_test.rb index 1057671a..23d2a76f 100644 --- a/test/finch_api/resources/sandbox/company_test.rb +++ b/test/finch_api/resources/sandbox/company_test.rb @@ -36,7 +36,7 @@ def test_update_required_params ein: String | nil, entity: FinchAPI::Models::Sandbox::CompanyUpdateResponse::Entity | nil, legal_name: String | nil, - locations: ^(FinchAPI::Internal::Type::ArrayOf[FinchAPI::Models::Location, nil?: true]) | nil, + locations: ^(FinchAPI::Internal::Type::ArrayOf[FinchAPI::Location, nil?: true]) | nil, primary_email: String | nil, primary_phone_number: String | nil } diff --git a/test/finch_api/resources/sandbox/employment_test.rb b/test/finch_api/resources/sandbox/employment_test.rb index be36ad12..6ce72f34 100644 --- a/test/finch_api/resources/sandbox/employment_test.rb +++ b/test/finch_api/resources/sandbox/employment_test.rb @@ -20,12 +20,12 @@ def test_update employment_status: FinchAPI::Models::Sandbox::EmploymentUpdateResponse::EmploymentStatus | nil, end_date: String | nil, first_name: String | nil, - income: FinchAPI::Models::Income | nil, - income_history: ^(FinchAPI::Internal::Type::ArrayOf[FinchAPI::Models::Income, nil?: true]) | nil, + income: FinchAPI::Income | nil, + income_history: ^(FinchAPI::Internal::Type::ArrayOf[FinchAPI::Income, nil?: true]) | nil, is_active: FinchAPI::Internal::Type::Boolean | nil, last_name: String | nil, latest_rehire_date: String | nil, - location: FinchAPI::Models::Location | nil, + location: FinchAPI::Location | nil, manager: FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Manager | nil, middle_name: String | nil, source_id: String | nil, diff --git a/test/finch_api/resources/sandbox/individual_test.rb b/test/finch_api/resources/sandbox/individual_test.rb index 1da64214..64285ae4 100644 --- a/test/finch_api/resources/sandbox/individual_test.rb +++ b/test/finch_api/resources/sandbox/individual_test.rb @@ -23,7 +23,7 @@ def test_update middle_name: String | nil, phone_numbers: ^(FinchAPI::Internal::Type::ArrayOf[FinchAPI::Models::Sandbox::IndividualUpdateResponse::PhoneNumber, nil?: true]) | nil, preferred_name: String | nil, - residence: FinchAPI::Models::Location | nil, + residence: FinchAPI::Location | nil, ssn: String | nil } end diff --git a/test/finch_api/resources/sandbox/jobs/configuration_test.rb b/test/finch_api/resources/sandbox/jobs/configuration_test.rb index 1d8a12ac..70c7addf 100644 --- a/test/finch_api/resources/sandbox/jobs/configuration_test.rb +++ b/test/finch_api/resources/sandbox/jobs/configuration_test.rb @@ -7,7 +7,7 @@ def test_retrieve response = @finch.sandbox.jobs.configuration.retrieve assert_pattern do - response => ^(FinchAPI::Internal::Type::ArrayOf[FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration]) + response => ^(FinchAPI::Internal::Type::ArrayOf[FinchAPI::Sandbox::Jobs::SandboxJobConfiguration]) end end @@ -15,13 +15,13 @@ def test_update_required_params response = @finch.sandbox.jobs.configuration.update(completion_status: :complete, type: :data_sync_all) assert_pattern do - response => FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration + response => FinchAPI::Sandbox::Jobs::SandboxJobConfiguration end assert_pattern do response => { - completion_status: FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration::CompletionStatus, - type: FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration::Type + completion_status: FinchAPI::Sandbox::Jobs::SandboxJobConfiguration::CompletionStatus, + type: FinchAPI::Sandbox::Jobs::SandboxJobConfiguration::Type } end end