diff --git a/.gitignore b/.gitignore index 8b1228a87..3d26ceede 100644 --- a/.gitignore +++ b/.gitignore @@ -1,10 +1,10 @@ *.gem .idea/ +.ignore .prism.log .ruby-lsp/ .yardoc/ -Brewfile.lock.json bin/tapioca +Brewfile.lock.json doc/ -sorbet/* -!/sorbet/config +sorbet/tapioca/* diff --git a/.release-please-manifest.json b/.release-please-manifest.json index 3b005e525..ee49ac2dc 100644 --- a/.release-please-manifest.json +++ b/.release-please-manifest.json @@ -1,3 +1,3 @@ { - ".": "0.1.0-alpha.10" + ".": "0.1.0-alpha.11" } \ No newline at end of file diff --git a/.ruby-version b/.ruby-version new file mode 100644 index 000000000..fd2a01863 --- /dev/null +++ b/.ruby-version @@ -0,0 +1 @@ +3.1.0 diff --git a/.stats.yml b/.stats.yml index 68698ff6f..b6d277351 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 199 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/increase%2Fincrease-1044f3fb430b9b4019ec3adeaa8b37e6615264fddb273a48b1d9ddd7c2b7b854.yml -openapi_spec_hash: c2526b64321711688cada903e7b4397d +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/increase%2Fincrease-77c909117116f16f4bd7d5596257445e57c54d288d6534fe5b11ee37126c4c34.yml +openapi_spec_hash: 29e929217173626e3edec897a5b6c5e7 config_hash: 20a463ecd33bd32b7b9bc6f4990907ac diff --git a/.yardopts b/.yardopts index 004c697b0..84c12f2a9 100644 --- a/.yardopts +++ b/.yardopts @@ -1,3 +1,5 @@ +--type-name-tag generic:Generic +--default-return void --markup markdown --markup-provider redcarpet --exclude /rbi diff --git a/CHANGELOG.md b/CHANGELOG.md index 77ea25e0d..c5021dcb5 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,39 @@ # Changelog +## 0.1.0-alpha.11 (2025-04-21) + +Full Changelog: [v0.1.0-alpha.10...v0.1.0-alpha.11](https://github.com/Increase/increase-ruby/compare/v0.1.0-alpha.10...v0.1.0-alpha.11) + +### Features + +* **api:** api update ([ae80e4b](https://github.com/Increase/increase-ruby/commit/ae80e4b0f18695b8056770456cb1e95cc3eae719)) +* **api:** api update ([7983dd2](https://github.com/Increase/increase-ruby/commit/7983dd2191954ebccf1e547cc78a4bd2f47e279d)) +* **api:** api update ([084fafd](https://github.com/Increase/increase-ruby/commit/084fafd7be0db3b6a1b04b54163a2d38aebacfd5)) +* **api:** api update ([b0dcacf](https://github.com/Increase/increase-ruby/commit/b0dcacfc8219d7ae549a79a40f57c1af5a94b208)) +* **client:** enable setting base URL from environment variable ([eecc22b](https://github.com/Increase/increase-ruby/commit/eecc22b9c93398f185f15bfe9f435df94c3c6f6f)) +* implement `#hash` for data containers ([68c733d](https://github.com/Increase/increase-ruby/commit/68c733d16baadd5f069a1fc13760bb6d1f22dfa7)) + + +### Bug Fixes + +* always send idempotency header when specified as a request option ([fda1fee](https://github.com/Increase/increase-ruby/commit/fda1fee2190a625869e4fd512c0174c904bdf90d)) +* **client:** send correct HTTP path ([5bec964](https://github.com/Increase/increase-ruby/commit/5bec9649252fed72bbca45f1c692552419b1813f)) +* restore ability to configure server environment as string during client construction ([e4764d3](https://github.com/Increase/increase-ruby/commit/e4764d326a2ffee3c344cd63d805a47bfbb0829f)) + + +### Chores + +* documentation improvements ([e6dfa3b](https://github.com/Increase/increase-ruby/commit/e6dfa3b4b14575590012703b80fe03e4f1f5d15e)) +* explicitly mark apis public under `Internal` module ([9f0a5dd](https://github.com/Increase/increase-ruby/commit/9f0a5dd4027d4d9a88f6b390e30fbda0820a262b)) +* **internal:** contribute.md and contributor QoL improvements ([314324d](https://github.com/Increase/increase-ruby/commit/314324d41279d0d25657d0fc8d962c2d66341537)) +* **internal:** minor type annotation improvements ([d9594f8](https://github.com/Increase/increase-ruby/commit/d9594f81d8e9e287f9a31427306b9706fde19216)) +* **internal:** protect SSE parsing pipeline from broken UTF-8 characters ([5a94369](https://github.com/Increase/increase-ruby/commit/5a943694f406e0fcb99497eb587dd4d3cd0452cf)) +* make sorbet enums easier to read ([e819d32](https://github.com/Increase/increase-ruby/commit/e819d322bc12b2e83396965dbd600d2ed2cf9a76)) +* refine `#inspect` and `#to_s` for model classes ([f19c447](https://github.com/Increase/increase-ruby/commit/f19c4478427850bbe790c8735ffeb1ee7bc5b562)) +* simplify yard annotations by removing most `@!parse` directives ([f02e474](https://github.com/Increase/increase-ruby/commit/f02e474bb85778b66357450e5b0c2c0d6d34ca8c)) +* update README with recommended editor plugins ([3c7848c](https://github.com/Increase/increase-ruby/commit/3c7848ce9d097c79e47204029b1c916f0cb864e2)) +* use `@!method` instead of `@!parse` for virtual method type definitions ([214dd6b](https://github.com/Increase/increase-ruby/commit/214dd6bc8aaef7e3a5aab216d6a22be1001beb54)) + ## 0.1.0-alpha.10 (2025-04-15) Full Changelog: [v0.1.0-alpha.9...v0.1.0-alpha.10](https://github.com/Increase/increase-ruby/compare/v0.1.0-alpha.9...v0.1.0-alpha.10) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..f2a771c83 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,125 @@ +## Setting up the environment + +This repository contains a `.ruby-version` file, which should work with either [rbenv](https://github.com/rbenv/rbenv) or [asdf](https://github.com/asdf-vm/asdf) with the [ruby plugin](https://github.com/asdf-vm/asdf-ruby). + +Please follow the instructions for your preferred version manager to install the Ruby version specified in the `.ruby-version` file. + +To set up the repository, run: + +```bash +$ ./scripts/bootstrap +``` + +This will install all the required dependencies. + +## Modifying/Adding code + +Most of the SDK is generated code. Modifications to code will be persisted between generations, but may result in merge conflicts between manual patches and changes from the generator. The generator will never modify the contents `examples/` directory. + +## Adding and running examples + +All files in the `examples/` directory are not modified by the generator and can be freely edited or added to. + +```ruby +#!/usr/bin/env ruby +# frozen_string_literal: true + +require_relative "../lib/increase" + +# ... +``` + +```bash +$ chmod +x './examples/.rb' + +# run the example against your api +$ ruby './examples/.rb' +``` + +## Using the repository from source + +If you’d like to use the repository from source, you can either install from git or reference a cloned repository: + +To install via git in your `Gemfile`: + +```ruby +gem "increase", git: "https://www.github.com/Increase/increase-ruby" +``` + +Alternatively, reference local copy of the repo: + +```bash +$ git clone -- 'https://www.github.com/Increase/increase-ruby' '' +``` + +```ruby +gem "increase", path: "" +``` + +## Running commands + +Running `rake` by itself will show all runnable commands. + +```bash +$ bundle exec rake +``` + +## Running tests + +Most tests require you to [set up a mock server](https://github.com/stoplightio/prism) against the OpenAPI spec to run the tests. + +```bash +$ npx prism mock path/to/your/openapi.yml +``` + +```bash +$ bundle exec rake test +``` + +## Linting and formatting + +This repository uses [rubocop](https://github.com/rubocop/rubocop) for linting and formatting of `*.rb` and `*.rbi` files. [syntax_tree](https://github.com/ruby-syntax-tree/syntax_tree) is used for formatting `*.rbs` files. + +There are two separate type checkers supported by this library: [sorbet](https://github.com/sorbet/sorbet) and [steep](https://github.com/soutaro/steep) are used for verifying `*.rbi` and `*.rbs` files respectively. + +To lint and typecheck: + +```bash +$ bundle exec rake lint +``` + +To format and fix all lint issues automatically: + +```bash +$ bundle exec rake format +``` + +## Editor Support + +### Ruby LSP + +[Ruby LSP](https://github.com/Shopify/ruby-lsp) has quite good support for go to definition, but not auto-completion. + +This can be installed along side Solargraph. + +### Solargraph + +[Solargraph](https://solargraph.org) has quite good support for auto-completion, but not go to definition. + +This can be installed along side Ruby LSP. + +### Sorbet + +[Sorbet](https://sorbet.org) should mostly work out of the box when editing this library directly. However, there are a some caveats due to the colocation of `*.rb` and `*.rbi` files in the same project. These issues should not otherwise manifest when this library is used as a dependency. + +1. For go to definition usages, sorbet might get confused and may not always navigate to the correct location. + +2. For each generic type in `*.rbi` files, a spurious "Duplicate type member" error is present. + +## Documentation Preview + +To preview the documentation, run: + +```bash +$ bundle exec rake docs:preview [PORT=8808] +``` diff --git a/Gemfile.lock b/Gemfile.lock index 61a55a225..51a1e8096 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -11,7 +11,7 @@ GIT PATH remote: . specs: - increase (0.1.0.pre.alpha.10) + increase (0.1.0.pre.alpha.11) connection_pool GEM diff --git a/README.md b/README.md index 3b790fdc8..4ef4d7fb9 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,7 @@ To use this gem, install via Bundler by adding the following to your application ```ruby -gem "increase", "~> 0.1.0.pre.alpha.10" +gem "increase", "~> 0.1.0.pre.alpha.11" ``` @@ -40,6 +40,20 @@ account = increase.accounts.create( puts(account.id) ``` +## Sorbet + +This library is written with [Sorbet type definitions](https://sorbet.org/docs/rbi). However, there is no runtime dependency on the `sorbet-runtime`. + +When using sorbet, it is recommended to use model classes as below. This provides stronger type checking and tooling integration. + +```ruby +increase.accounts.create( + name: "New Account!", + entity_id: "entity_n8y8tnk2p9339ti393yi", + program_id: "program_i2v2os4mwza1oetokh9i" +) +``` + ### Pagination List methods in the Increase API are paginated. @@ -67,11 +81,11 @@ Request parameters that correspond to file uploads can be passed as `StringIO`, require "pathname" # using `Pathname`, the file will be lazily read, without reading everything in to memory -file = increase.files.create(file: Pathname("my/file.txt"), purpose: "check_image_front") +file = increase.files.create(file: Pathname("my/file.txt"), purpose: :check_image_front) file = File.read("my/file.txt") # using `StringIO`, useful if you already have the data in memory -file = increase.files.create(file: StringIO.new(file), purpose: "check_image_front") +file = increase.files.create(file: StringIO.new(file), purpose: :check_image_front) puts(file.id) ``` @@ -149,65 +163,38 @@ increase.accounts.create( ) ``` -## LSP Support - -### Solargraph - -This library includes [Solargraph](https://solargraph.org) support for both auto completion and go to definition. - -```ruby -gem "solargraph", group: :development -``` - -After Solargraph is installed, **you must populate its index** either via the provided editor command, or by running the following in your terminal: - -```sh -bundle exec solargraph gems -``` +## Model DSL -Note: if you had installed the gem either using a `git:` or `github:` URL, or had vendored the gem using bundler, you will need to set up your [`.solargraph.yml`](https://solargraph.org/guides/configuration) to include the path to the gem's `lib` directory. +This library uses a simple DSL to represent request parameters and response shapes in `lib/increase/models`. -```yaml -include: - - 'vendor/bundle/ruby/*/gems/increase-*/lib/**/*.rb' -``` - -Otherwise Solargraph will not be able to provide type information or auto-completion for any non-indexed libraries. - -### Sorbet - -This library is written with [Sorbet type definitions](https://sorbet.org/docs/rbi). However, there is no runtime dependency on the `sorbet-runtime`. +With the right [editor plugins](https://shopify.github.io/ruby-lsp), you can ctrl-click on elements of the DSL to navigate around and explore the library. -What this means is that while you can use Sorbet to type check your code statically, and benefit from the [Sorbet Language Server](https://sorbet.org/docs/lsp) in your editor, there is no runtime type checking and execution overhead from Sorbet itself. - -Due to limitations with the Sorbet type system, where a method otherwise can take an instance of `Increase::BaseModel` class, you will need to use the `**` splat operator to pass the arguments: - -Please follow Sorbet's [setup guides](https://sorbet.org/docs/adopting) for best experience. +In all places where a `BaseModel` type is specified, vanilla Ruby `Hash` can also be used. For example, the following are interchangeable as arguments: ```ruby +# This has tooling readability, for auto-completion, static analysis, and goto definition with supported language services params = Increase::Models::AccountCreateParams.new( name: "New Account!", entity_id: "entity_n8y8tnk2p9339ti393yi", program_id: "program_i2v2os4mwza1oetokh9i" ) -increase.accounts.create(**params) +# This also works +params = { + name: "New Account!", + entity_id: "entity_n8y8tnk2p9339ti393yi", + program_id: "program_i2v2os4mwza1oetokh9i" +} ``` -Note: **This library emits an intentional warning under the [`tapioca` toolchain](https://github.com/Shopify/tapioca)**. This is normal, and does not impact functionality. - -### Ruby LSP +## Editor support -The Ruby LSP has [best effort support](https://shopify.github.io/ruby-lsp/#guessed-types) for inferring type information from Ruby code, and as such it may not always be able to provide accurate type information. +A combination of [Shopify LSP](https://shopify.github.io/ruby-lsp) and [Solargraph](https://solargraph.org/) is recommended for non-[Sorbet](https://sorbet.org) users. The former is especially good at go to definition, while the latter has much better auto-completion support. -## Advanced +## Advanced concepts ### Making custom/undocumented requests -This library is typed for convenient access to the documented API. - -If you need to access undocumented endpoints, params, or response properties, the library can still be used. - #### Undocumented request params If you want to explicitly send an extra param, you can do so with the `extra_query`, `extra_body`, and `extra_headers` under the `request_options:` parameter when making a requests as seen in examples above. @@ -218,15 +205,15 @@ To make requests to undocumented endpoints, you can make requests using `client. ```ruby response = client.request( - method: :post, - path: '/undocumented/endpoint', - query: {"dog": "woof"}, - headers: {"useful-header": "interesting-value"}, - body: {"he": "llo"}, - ) + method: :post, + path: '/undocumented/endpoint', + query: {"dog": "woof"}, + headers: {"useful-header": "interesting-value"}, + body: {"he": "llo"}, +) ``` -### Concurrency & Connection Pooling +### Concurrency & connection pooling The `Increase::Client` instances are thread-safe, and should be re-used across multiple threads. By default, each `Client` have their own HTTP connection pool, with a maximum number of connections equal to thread count. @@ -236,6 +223,21 @@ Unless otherwise specified, other classes in the SDK do not have locks protectin Currently, `Increase::Client` instances are only fork-safe if there are no in-flight HTTP requests. +### Sorbet + +#### Argument passing trick + +It is possible to pass a compatible model / parameter class to a method that expects keyword arguments by using the `**` splat operator. + +```ruby +params = Increase::Models::AccountCreateParams.new( + name: "New Account!", + entity_id: "entity_n8y8tnk2p9339ti393yi", + program_id: "program_i2v2os4mwza1oetokh9i" +) +increase.accounts.create(**params) +``` + ## Versioning This package follows [SemVer](https://semver.org/spec/v2.0.0.html) conventions. As the library is in initial development and has a major version of `0`, APIs may change at any time. @@ -245,3 +247,7 @@ This package considers improvements to the (non-runtime) `*.rbi` and `*.rbs` typ ## Requirements Ruby 3.1.0 or higher. + +## Contributing + +See [the contributing documentation](https://github.com/Increase/increase-ruby/tree/main/CONTRIBUTING.md). diff --git a/Rakefile b/Rakefile index 3bbb7689d..5b270b07a 100644 --- a/Rakefile +++ b/Rakefile @@ -1,5 +1,6 @@ # frozen_string_literal: true +require "pathname" require "securerandom" require "shellwords" @@ -7,10 +8,23 @@ require "minitest/test_task" require "rake/clean" require "rubocop/rake_task" -CLEAN.push(*%w[.idea/ .ruby-lsp/ .yardoc/]) +tapioca = "sorbet/tapioca" +ignore_file = ".ignore" -multitask(default: [:test]) +CLEAN.push(*%w[.idea/ .ruby-lsp/ .yardoc/ doc/], *FileList["*.gem"], ignore_file) +CLOBBER.push(*%w[sorbet/rbi/annotations/ sorbet/rbi/gems/], tapioca) + +multitask(:default) do + sh(*%w[rake --tasks]) +end + +desc("Preview docs; use `PORT=` to change the port") +multitask(:"docs:preview") do + sh(*%w[yard server --reload --quiet --bind [::] --port], ENV.fetch("PORT", "8808")) +end + +desc("Run test suites; use `TEST=path/to/test.rb` to run a specific test file") multitask(:test) do rb = FileList[ENV.fetch("TEST", "./test/**/*_test.rb")] @@ -23,17 +37,20 @@ 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 --] -multitask(:rubocop) do +desc("Lint `*.rb(i)`") +multitask(:"lint:rubocop") do lint = xargs + %w[rubocop --fail-level E] + (ENV.key?("CI") ? %w[--format github] : []) sh("#{rubo_find.shelljoin} | #{lint.shelljoin}") end -multitask(:ruboformat) do +desc("Format `*.rb(i)`") +multitask(:"format:rubocop") do fmt = xargs + %w[rubocop --fail-level F --autocorrect --format simple --] sh("#{rubo_find.shelljoin} | #{fmt.shelljoin}") end -multitask(:syntax_tree) do +desc("Format `*.rbs`") +multitask(:"format:syntax_tree") do find = %w[find ./sig -type f -name *.rbs -print0] inplace = /darwin|bsd/ =~ RUBY_PLATFORM ? %w[-i''] : %w[-i] uuid = SecureRandom.uuid @@ -74,27 +91,49 @@ multitask(:syntax_tree) do fail unless success end -multitask(format: [:ruboformat, :syntax_tree]) +desc("Format everything") +multitask(format: [:"format:rubocop", :"format:syntax_tree"]) -multitask(:steep) do +desc("Typecheck `*.rbs`") +multitask(:"typecheck:steep") do sh(*%w[steep check]) end -multitask(:sorbet) do +desc("Typecheck `*.rbi`") +multitask(:"typecheck:sorbet") do sh(*%w[srb typecheck]) end -file("sorbet/tapioca") do +file(tapioca) do sh(*%w[tapioca init]) end -multitask(typecheck: [:steep, :sorbet]) -multitask(lint: [:rubocop, :typecheck]) +desc("Typecheck everything") +multitask(typecheck: [:"typecheck:steep", :"typecheck:sorbet"]) + +desc("Lint and typecheck") +multitask(lint: [:"lint:rubocop", :typecheck]) + +desc("Build yard docs") +multitask(:"build:docs") do + sh(*%w[yard]) +end -multitask(:build) do - sh(*%w[gem build -- increase.gemspec]) +desc("Build ruby gem") +multitask(:"build:gem") do + # optimizing for grepping through the gem bundle: many tools honour `.ignore` files, including VSCode + # + # both `rbi` and `sig` directories are navigable by their respective tool chains and therefore can be ignored by tools such as `rg` + Pathname(ignore_file).write(<<~GLOB) + rbi/* + sig/* + GLOB + + sh(*%w[gem build -- openai.gemspec]) + rm_rf(ignore_file) end -multitask(release: [:build]) do +desc("Release ruby gem") +multitask(release: [:"build:gem"]) do sh(*%w[gem push], *FileList["increase-*.gem"]) end diff --git a/Steepfile b/Steepfile index 6e5d0ac58..d7aebca17 100644 --- a/Steepfile +++ b/Steepfile @@ -2,7 +2,7 @@ require "yaml" -target :lib do +target(:lib) do configure_code_diagnostics(Steep::Diagnostic::Ruby.strict) signature("sig") diff --git a/increase.gemspec b/increase.gemspec index 70bfd43a2..a35ec28b6 100644 --- a/increase.gemspec +++ b/increase.gemspec @@ -8,12 +8,21 @@ Gem::Specification.new do |s| s.summary = "Ruby library to access the Increase API" s.authors = ["Increase"] s.email = "dev-feedback@increase.com" - s.files = Dir["lib/**/*.rb", "rbi/**/*.rbi", "sig/**/*.rbs", "manifest.yaml", "CHANGELOG.md", "SECURITY.md"] - s.extra_rdoc_files = ["README.md"] - s.required_ruby_version = ">= 3.0.0" - s.add_dependency "connection_pool" s.homepage = "https://gemdocs.org/gems/increase" s.metadata["homepage_uri"] = s.homepage s.metadata["source_code_uri"] = "https://github.com/Increase/increase-ruby" s.metadata["rubygems_mfa_required"] = false.to_s + s.required_ruby_version = ">= 3.0.0" + + s.files = Dir[ + "lib/**/*.rb", + "rbi/**/*.rbi", + "sig/**/*.rbs", + "manifest.yaml", + "SECURITY.md", + "CHANGELOG.md", + ".ignore" + ] + s.extra_rdoc_files = ["README.md"] + s.add_dependency "connection_pool" end diff --git a/lib/increase.rb b/lib/increase.rb index 540bdb78f..35adf59fc 100644 --- a/lib/increase.rb +++ b/lib/increase.rb @@ -19,15 +19,6 @@ # We already ship the preferred sorbet manifests in the package itself. # `tapioca` currently does not offer us a way to opt out of unnecessary compilation. if Object.const_defined?(:Tapioca) && caller.chain([$PROGRAM_NAME]).chain(ARGV).grep(/tapioca/) - Warning.warn( - <<~WARN - \n - ⚠️ skipped loading of "increase" gem under `tapioca`. - - This message is normal and expected if you are running a `tapioca` command, and does not impact `.rbi` generation. - \n - WARN - ) return end diff --git a/lib/increase/client.rb b/lib/increase/client.rb index 184231290..eedf21ef9 100644 --- a/lib/increase/client.rb +++ b/lib/increase/client.rb @@ -205,7 +205,8 @@ class Client < Increase::Internal::Transport::BaseClient # - `production` corresponds to `https://api.increase.com` # - `sandbox` corresponds to `https://sandbox.increase.com` # - # @param base_url [String, nil] Override the default base URL for the API, e.g., `"https://api.example.com/v2/"` + # @param base_url [String, nil] Override the default base URL for the API, e.g., + # `"https://api.example.com/v2/"`. Defaults to `ENV["INCREASE_BASE_URL"]` # # @param max_retries [Integer] Max number of retries to attempt after a failed retryable request. # @@ -219,22 +220,16 @@ class Client < Increase::Internal::Transport::BaseClient def initialize( api_key: ENV["INCREASE_API_KEY"], environment: nil, - base_url: nil, - max_retries: DEFAULT_MAX_RETRIES, - timeout: DEFAULT_TIMEOUT_IN_SECONDS, - initial_retry_delay: DEFAULT_INITIAL_RETRY_DELAY, - max_retry_delay: DEFAULT_MAX_RETRY_DELAY, + base_url: ENV["INCREASE_BASE_URL"], + max_retries: Increase::Client::DEFAULT_MAX_RETRIES, + timeout: Increase::Client::DEFAULT_TIMEOUT_IN_SECONDS, + initial_retry_delay: Increase::Client::DEFAULT_INITIAL_RETRY_DELAY, + max_retry_delay: Increase::Client::DEFAULT_MAX_RETRY_DELAY, idempotency_header: "Idempotency-Key" ) - case [environment, base_url] - in [Symbol | String, String] - raise ArgumentError.new("both environment and base_url given, expected only one") - in [Symbol | String, nil] - base_url = ENVIRONMENTS.fetch(environment.to_sym) do - raise ArgumentError.new("environment must be one of #{ENVIRONMENTS.keys}, got #{environment}") - end - else - base_url ||= ENVIRONMENTS.fetch(:production) + base_url ||= Increase::Client::ENVIRONMENTS.fetch(environment&.to_sym || :production) do + message = "environment must be one of #{Increase::Client::ENVIRONMENTS.keys}, got #{environment}" + raise ArgumentError.new(message) end if api_key.nil? diff --git a/lib/increase/internal.rb b/lib/increase/internal.rb index 2be0303e6..68d965595 100644 --- a/lib/increase/internal.rb +++ b/lib/increase/internal.rb @@ -1,7 +1,6 @@ # frozen_string_literal: true module Increase - # @api private module Internal OMIT = Object.new.tap do diff --git a/lib/increase/internal/page.rb b/lib/increase/internal/page.rb index 05f31f70c..d32c30151 100644 --- a/lib/increase/internal/page.rb +++ b/lib/increase/internal/page.rb @@ -28,7 +28,7 @@ def next_page? end # @raise [Increase::HTTP::Error] - # @return [Increase::Internal::Page] + # @return [self] def next_page unless next_page? message = "No more pages available. Please check #next_page? before calling ##{__method__}" diff --git a/lib/increase/internal/transport/base_client.rb b/lib/increase/internal/transport/base_client.rb index cb3d117f6..61ee3b397 100644 --- a/lib/increase/internal/transport/base_client.rb +++ b/lib/increase/internal/transport/base_client.rb @@ -216,9 +216,9 @@ def initialize( # # @option req [Symbol, nil] :unwrap # - # @option req [Class, nil] :page + # @option req [Class, nil] :page # - # @option req [Class, nil] :stream + # @option req [Class, nil] :stream # # @option req [Increase::Internal::Type::Converter, Class, nil] :model # @@ -253,7 +253,7 @@ def initialize( if @idempotency_header && !headers.key?(@idempotency_header) && - !Net::HTTP::IDEMPOTENT_METHODS_.include?(method.to_s.upcase) + (!Net::HTTP::IDEMPOTENT_METHODS_.include?(method.to_s.upcase) || opts.key?(:idempotency_key)) headers[@idempotency_header] = opts.fetch(:idempotency_key) { generate_idempotency_key } end @@ -417,9 +417,9 @@ def initialize( # # @param unwrap [Symbol, nil] # - # @param page [Class, nil] + # @param page [Class, nil] # - # @param stream [Class, nil] + # @param stream [Class, nil] # # @param model [Increase::Internal::Type::Converter, Class, nil] # diff --git a/lib/increase/internal/transport/pooled_net_requester.rb b/lib/increase/internal/transport/pooled_net_requester.rb index 675d4bbec..7657209dc 100644 --- a/lib/increase/internal/transport/pooled_net_requester.rb +++ b/lib/increase/internal/transport/pooled_net_requester.rb @@ -61,7 +61,7 @@ def build_request(request, &blk) method.to_s.upcase, !body.nil?, method != :head, - url.to_s + URI(url.to_s) # ensure we construct a URI class of the right scheme ) headers.each { req[_1] = _2 } @@ -149,7 +149,7 @@ def execute(request) break if finished rsp.read_body do |bytes| - y << bytes + y << bytes.force_encoding(Encoding::BINARY) break if finished self.class.calibrate_socket_timeout(conn, deadline) diff --git a/lib/increase/internal/type/array_of.rb b/lib/increase/internal/type/array_of.rb index 65ea2f424..345fafbdf 100644 --- a/lib/increase/internal/type/array_of.rb +++ b/lib/increase/internal/type/array_of.rb @@ -28,13 +28,19 @@ class ArrayOf # @option spec [Proc] :union # # @option spec [Boolean] :"nil?" + # + # @return [Increase::Internal::Type::ArrayOf] def self.[](...) = new(...) + # @api public + # # @param other [Object] # # @return [Boolean] def ===(other) = other.is_a?(Array) && other.all?(item_type) + # @api public + # # @param other [Object] # # @return [Boolean] @@ -44,6 +50,11 @@ def ==(other) # rubocop:enable Layout/LineLength end + # @api public + # + # @return [Integer] + def hash = [self.class, item_type].hash + # @api private # # @param value [Array, Object] diff --git a/lib/increase/internal/type/base_model.rb b/lib/increase/internal/type/base_model.rb index fab12c0b4..3b9650846 100644 --- a/lib/increase/internal/type/base_model.rb +++ b/lib/increase/internal/type/base_model.rb @@ -4,14 +4,6 @@ module Increase module Internal module Type # @abstract - # - # @example - # # `account` is a `Increase::Models::Account` - # account => { - # id: id, - # bank: bank, - # closed_at: closed_at - # } class BaseModel extend Increase::Internal::Type::Converter @@ -100,11 +92,13 @@ def fields state: state ) end - rescue StandardError + rescue StandardError => e cls = self.class.name.split("::").last - # rubocop:disable Layout/LineLength - message = "Failed to parse #{cls}.#{__method__} from #{value.class} to #{target.inspect}. To get the unparsed API response, use #{cls}[:#{__method__}]." - # rubocop:enable Layout/LineLength + message = [ + "Failed to parse #{cls}.#{__method__} from #{value.class} to #{target.inspect}.", + "To get the unparsed API response, use #{cls}[#{__method__.inspect}].", + "Cause: #{e.message}" + ].join(" ") raise Increase::Errors::ConversionError.new(message) end end @@ -172,19 +166,33 @@ def optional(name_sym, type_info, spec = {}) @mode = nil end + # @api public + # # @param other [Object] # # @return [Boolean] def ==(other) other.is_a?(Class) && other <= Increase::Internal::Type::BaseModel && other.fields == fields end + + # @api public + # + # @return [Integer] + def hash = fields.hash end + # @api public + # # @param other [Object] # # @return [Boolean] def ==(other) = self.class == other.class && @data == other.to_h + # @api public + # + # @return [Integer] + def hash = [self.class, @data].hash + class << self # @api private # @@ -298,6 +306,8 @@ def dump(value, state:) end end + # @api public + # # Returns the raw value associated with the given key, if found. Otherwise, nil is # returned. # @@ -316,6 +326,8 @@ def [](key) @data[key] end + # @api public + # # Returns a Hash of the data underlying this object. O(1) # # Keys are Symbols and values are the raw values from the response. The return @@ -345,11 +357,38 @@ def deconstruct_keys(keys) .to_h end + class << self + # @api private + # + # @param model [Increase::Internal::Type::BaseModel] + # + # @return [Hash{Symbol=>Object}] + def walk(model) + walk = ->(x) do + case x + in Increase::Internal::Type::BaseModel + walk.call(x.to_h) + in Hash + x.transform_values(&walk) + in Array + x.map(&walk) + else + x + end + end + walk.call(model) + end + end + + # @api public + # # @param a [Object] # # @return [String] def to_json(*a) = Increase::Internal::Type::Converter.dump(self.class, self).to_json(*a) + # @api public + # # @param a [Object] # # @return [String] @@ -357,7 +396,7 @@ def to_yaml(*a) = Increase::Internal::Type::Converter.dump(self.class, self).to_ # Create a new instance of a model. # - # @param data [Hash{Symbol=>Object}, Increase::Internal::Type::BaseModel] + # @param data [Hash{Symbol=>Object}, self] def initialize(data = {}) case Increase::Internal::Util.coerce_hash(data) in Hash => coerced @@ -380,31 +419,26 @@ def inspect(depth: 0) depth = depth.succ deferred = fields.transform_values do |field| type, required, nilable = field.fetch_values(:type, :required, :nilable) - -> do - [ - Increase::Internal::Type::Converter.inspect(type, depth: depth), - !required || nilable ? "nil" : nil - ].compact.join(" | ") - end - .tap { _1.define_singleton_method(:inspect) { call } } + inspected = [ + Increase::Internal::Type::Converter.inspect(type, depth: depth), + !required || nilable ? "nil" : nil + ].compact.join(" | ") + -> { inspected }.tap { _1.define_singleton_method(:inspect) { call } } end "#{name}[#{deferred.inspect}]" end end - # @api private + # @api public # # @return [String] - def inspect - rows = @data.map do - "#{_1}=#{self.class.known_fields.key?(_1) ? public_send(_1).inspect : ''}" - rescue Increase::Errors::ConversionError - "#{_1}=#{_2.inspect}" - end + def to_s = self.class.walk(@data).to_s - "#<#{self.class}:0x#{object_id.to_s(16)} #{rows.join(' ')}>" - end + # @api private + # + # @return [String] + def inspect = "#<#{self.class}:0x#{object_id.to_s(16)} #{self}>" end end end diff --git a/lib/increase/internal/type/base_page.rb b/lib/increase/internal/type/base_page.rb index 63c947068..df453f6df 100644 --- a/lib/increase/internal/type/base_page.rb +++ b/lib/increase/internal/type/base_page.rb @@ -3,19 +3,27 @@ module Increase module Internal module Type + # @api private + # # @generic Elem # # This module provides a base implementation for paginated responses in the SDK. module BasePage # rubocop:disable Lint/UnusedMethodArgument + # @api public + # # @return [Boolean] def next_page? = (raise NotImplementedError) + # @api public + # # @raise [Increase::Errors::APIError] - # @return [Increase::Internal::Type::BasePage] + # @return [self] def next_page = (raise NotImplementedError) + # @api public + # # @param blk [Proc] # # @yieldparam [generic] diff --git a/lib/increase/internal/type/boolean.rb b/lib/increase/internal/type/boolean.rb index 35d9f8b6d..6cce36fde 100644 --- a/lib/increase/internal/type/boolean.rb +++ b/lib/increase/internal/type/boolean.rb @@ -13,11 +13,15 @@ class Boolean private_class_method :new + # @api public + # # @param other [Object] # # @return [Boolean] def self.===(other) = other == true || other == false + # @api public + # # @param other [Object] # # @return [Boolean] diff --git a/lib/increase/internal/type/enum.rb b/lib/increase/internal/type/enum.rb index 1da9a38ce..9f9deebbb 100644 --- a/lib/increase/internal/type/enum.rb +++ b/lib/increase/internal/type/enum.rb @@ -21,18 +21,17 @@ module Enum # All of the valid Symbol values for this enum. # # @return [Array] - def values = (@values ||= constants.map { const_get(_1) }) + def values = constants.map { const_get(_1) } - # @api private + # @api public # - # Guard against thread safety issues by instantiating `@values`. - private def finalize! = values - # @param other [Object] # # @return [Boolean] def ===(other) = values.include?(other) + # @api public + # # @param other [Object] # # @return [Boolean] @@ -42,6 +41,11 @@ def ==(other) # rubocop:enable Style/CaseEquality end + # @api public + # + # @return [Integer] + def hash = values.to_set.hash + # @api private # # Unlike with primitives, `Enum` additionally validates that the value is a member diff --git a/lib/increase/internal/type/hash_of.rb b/lib/increase/internal/type/hash_of.rb index 6a4413682..7b482a157 100644 --- a/lib/increase/internal/type/hash_of.rb +++ b/lib/increase/internal/type/hash_of.rb @@ -28,8 +28,12 @@ class HashOf # @option spec [Proc] :union # # @option spec [Boolean] :"nil?" + # + # @return [Increase::Internal::Type::HashOf] def self.[](...) = new(...) + # @api public + # # @param other [Object] # # @return [Boolean] @@ -50,6 +54,8 @@ def ===(other) end end + # @api public + # # @param other [Object] # # @return [Boolean] @@ -59,6 +65,11 @@ def ==(other) # rubocop:enable Layout/LineLength end + # @api public + # + # @return [Integer] + def hash = [self.class, item_type].hash + # @api private # # @param value [Hash{Object=>Object}, Object] diff --git a/lib/increase/internal/type/io_like.rb b/lib/increase/internal/type/io_like.rb index e108d2618..986a717f0 100644 --- a/lib/increase/internal/type/io_like.rb +++ b/lib/increase/internal/type/io_like.rb @@ -13,6 +13,8 @@ class IOLike private_class_method :new + # @api public + # # @param other [Object] # # @return [Boolean] @@ -25,6 +27,8 @@ def self.===(other) end end + # @api public + # # @param other [Object] # # @return [Boolean] diff --git a/lib/increase/internal/type/request_parameters.rb b/lib/increase/internal/type/request_parameters.rb index 1f89b6344..4ef2a1c53 100644 --- a/lib/increase/internal/type/request_parameters.rb +++ b/lib/increase/internal/type/request_parameters.rb @@ -12,9 +12,8 @@ module RequestParameters # @param mod [Module] def self.included(mod) - return unless mod <= Increase::Internal::Type::BaseModel + raise ArgumentError.new(mod) unless mod <= Increase::Internal::Type::BaseModel - mod.extend(Increase::Internal::Type::RequestParameters::Converter) mod.optional(:request_options, Increase::RequestOptions) end diff --git a/lib/increase/internal/type/union.rb b/lib/increase/internal/type/union.rb index 5e57227ad..be2a9ab0b 100644 --- a/lib/increase/internal/type/union.rb +++ b/lib/increase/internal/type/union.rb @@ -18,7 +18,7 @@ module Union # # @return [Array] protected def derefed_variants - @known_variants.map { |key, variant_fn| [key, variant_fn.call] } + known_variants.map { |key, variant_fn| [key, variant_fn.call] } end # All of the specified variants for this union. @@ -87,6 +87,8 @@ def variants = derefed_variants.map(&:last) # rubocop:disable Style/HashEachMethods # rubocop:disable Style/CaseEquality + # @api public + # # @param other [Object] # # @return [Boolean] @@ -96,6 +98,8 @@ def ===(other) end end + # @api public + # # @param other [Object] # # @return [Boolean] @@ -103,6 +107,11 @@ def ==(other) Increase::Internal::Type::Union === other && other.derefed_variants == derefed_variants end + # @api public + # + # @return [Integer] + def hash = variants.hash + # @api private # # @param value [Object] diff --git a/lib/increase/internal/type/unknown.rb b/lib/increase/internal/type/unknown.rb index 30bd44c75..dadb86d08 100644 --- a/lib/increase/internal/type/unknown.rb +++ b/lib/increase/internal/type/unknown.rb @@ -15,11 +15,15 @@ class Unknown private_class_method :new + # @api public + # # @param other [Object] # # @return [Boolean] def self.===(other) = true + # @api public + # # @param other [Object] # # @return [Boolean] diff --git a/lib/increase/internal/util.rb b/lib/increase/internal/util.rb index 480b8b047..1e54c71ff 100644 --- a/lib/increase/internal/util.rb +++ b/lib/increase/internal/util.rb @@ -448,7 +448,7 @@ def initialize(src, &blk) else src end - @buf = String.new.b + @buf = String.new @blk = blk end end @@ -460,7 +460,7 @@ class << self # @return [Enumerable] def writable_enum(&blk) Enumerator.new do |y| - buf = String.new.b + buf = String.new y.define_singleton_method(:write) do self << buf.replace(_1) buf.bytesize @@ -582,6 +582,27 @@ def encode_content(headers, body) # @api private # + # https://www.iana.org/assignments/character-sets/character-sets.xhtml + # + # @param content_type [String] + # @param text [String] + def force_charset!(content_type, text:) + charset = /charset=([^;\s]+)/.match(content_type)&.captures&.first + + return unless charset + + begin + encoding = Encoding.find(charset) + text.force_encoding(encoding) + rescue ArgumentError + nil + end + end + + # @api private + # + # Assumes each chunk in stream has `Encoding::BINARY`. + # # @param headers [Hash{String=>String}, Net::HTTPHeader] # @param stream [Enumerable] # @param suppress_error [Boolean] @@ -589,7 +610,7 @@ def encode_content(headers, body) # @raise [JSON::ParserError] # @return [Object] def decode_content(headers, stream:, suppress_error: false) - case headers["content-type"] + case (content_type = headers["content-type"]) in %r{^application/(?:vnd\.api\+)?json} json = stream.to_a.join begin @@ -606,11 +627,10 @@ def decode_content(headers, stream:, suppress_error: false) in %r{^text/event-stream} lines = decode_lines(stream) decode_sse(lines) - in %r{^text/} - stream.to_a.join else - # TODO: parsing other response types - StringIO.new(stream.to_a.join) + text = stream.to_a.join + force_charset!(content_type, text: text) + StringIO.new(text) end end end @@ -675,12 +695,17 @@ def chain_fused(enum, &blk) class << self # @api private # + # Assumes Strings have been forced into having `Encoding::BINARY`. + # + # This decoder is responsible for reassembling lines split across multiple + # fragments. + # # @param enum [Enumerable] # # @return [Enumerable] def decode_lines(enum) re = /(\r\n|\r|\n)/ - buffer = String.new.b + buffer = String.new cr_seen = nil chain_fused(enum) do |y| @@ -711,6 +736,8 @@ def decode_lines(enum) # # https://html.spec.whatwg.org/multipage/server-sent-events.html#parsing-an-event-stream # + # Assumes that `lines` has been decoded with `#decode_lines`. + # # @param lines [Enumerable] # # @return [EnumerableObject}>] @@ -734,7 +761,7 @@ def decode_sse(lines) in "event" current.merge!(event: value) in "data" - (current[:data] ||= String.new.b) << (value << "\n") + (current[:data] ||= String.new) << (value << "\n") in "id" unless value.include?("\0") current.merge!(id: value) in "retry" if /^\d+$/ =~ value diff --git a/lib/increase/models/account.rb b/lib/increase/models/account.rb index 0df32c9db..ac65714a3 100644 --- a/lib/increase/models/account.rb +++ b/lib/increase/models/account.rb @@ -106,48 +106,25 @@ class Account < Increase::Internal::Type::BaseModel # @return [Symbol, Increase::Models::Account::Type] required :type, enum: -> { Increase::Models::Account::Type } - # @!parse - # # Accounts are your bank accounts with Increase. They store money, receive - # # transfers, and send payments. They earn interest and have depository insurance. - # # - # # @param id [String] - # # @param bank [Symbol, Increase::Models::Account::Bank] - # # @param closed_at [Time, nil] - # # @param created_at [Time] - # # @param currency [Symbol, Increase::Models::Account::Currency] - # # @param entity_id [String, nil] - # # @param idempotency_key [String, nil] - # # @param informational_entity_id [String, nil] - # # @param interest_accrued [String] - # # @param interest_accrued_at [Date, nil] - # # @param interest_rate [String] - # # @param name [String] - # # @param program_id [String] - # # @param status [Symbol, Increase::Models::Account::Status] - # # @param type [Symbol, Increase::Models::Account::Type] - # # - # def initialize( - # id:, - # bank:, - # closed_at:, - # created_at:, - # currency:, - # entity_id:, - # idempotency_key:, - # informational_entity_id:, - # interest_accrued:, - # interest_accrued_at:, - # interest_rate:, - # name:, - # program_id:, - # status:, - # type:, - # ** - # ) - # super - # end - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(id:, bank:, closed_at:, created_at:, currency:, entity_id:, idempotency_key:, informational_entity_id:, interest_accrued:, interest_accrued_at:, interest_rate:, name:, program_id:, status:, type:) + # Accounts are your bank accounts with Increase. They store money, receive + # transfers, and send payments. They earn interest and have depository insurance. + # + # @param id [String] + # @param bank [Symbol, Increase::Models::Account::Bank] + # @param closed_at [Time, nil] + # @param created_at [Time] + # @param currency [Symbol, Increase::Models::Account::Currency] + # @param entity_id [String, nil] + # @param idempotency_key [String, nil] + # @param informational_entity_id [String, nil] + # @param interest_accrued [String] + # @param interest_accrued_at [Date, nil] + # @param interest_rate [String] + # @param name [String] + # @param program_id [String] + # @param status [Symbol, Increase::Models::Account::Status] + # @param type [Symbol, Increase::Models::Account::Type] # The bank the Account is with. # @@ -164,11 +141,8 @@ module Bank # Grasshopper Bank GRASSHOPPER_BANK = :grasshopper_bank - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the Account @@ -196,11 +170,8 @@ module Currency # US Dollar (USD) USD = :USD - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # The status of the Account. @@ -215,11 +186,8 @@ module Status # Open Accounts that are ready to use. OPEN = :open - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # A constant representing the object's type. For this resource it will always be @@ -231,11 +199,8 @@ module Type ACCOUNT = :account - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end diff --git a/lib/increase/models/account_balance_params.rb b/lib/increase/models/account_balance_params.rb index 32344463a..7e4f090e2 100644 --- a/lib/increase/models/account_balance_params.rb +++ b/lib/increase/models/account_balance_params.rb @@ -4,27 +4,18 @@ module Increase module Models # @see Increase::Resources::Accounts#balance class AccountBalanceParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters - # @!attribute [r] at_time + # @!attribute at_time # The moment to query the balance at. If not set, returns the current balances. # # @return [Time, nil] optional :at_time, Time - # @!parse - # # @return [Time] - # attr_writer :at_time - - # @!parse - # # @param at_time [Time] - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(at_time: nil, request_options: {}, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(at_time: nil, request_options: {}) + # @param at_time [Time] + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/increase/models/account_close_params.rb b/lib/increase/models/account_close_params.rb index 502e3de05..84670512d 100644 --- a/lib/increase/models/account_close_params.rb +++ b/lib/increase/models/account_close_params.rb @@ -4,16 +4,11 @@ module Increase module Models # @see Increase::Resources::Accounts#close class AccountCloseParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters - # @!parse - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(request_options: {}, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(request_options: {}) + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/increase/models/account_create_params.rb b/lib/increase/models/account_create_params.rb index 1a5068ce7..e93eb0f31 100644 --- a/lib/increase/models/account_create_params.rb +++ b/lib/increase/models/account_create_params.rb @@ -4,8 +4,7 @@ module Increase module Models # @see Increase::Resources::Accounts#create class AccountCreateParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters # @!attribute name @@ -14,48 +13,32 @@ class AccountCreateParams < Increase::Internal::Type::BaseModel # @return [String] required :name, String - # @!attribute [r] entity_id + # @!attribute entity_id # The identifier for the Entity that will own the Account. # # @return [String, nil] optional :entity_id, String - # @!parse - # # @return [String] - # attr_writer :entity_id - - # @!attribute [r] informational_entity_id + # @!attribute informational_entity_id # The identifier of an Entity that, while not owning the Account, is associated # with its activity. Its relationship to your group must be `informational`. # # @return [String, nil] optional :informational_entity_id, String - # @!parse - # # @return [String] - # attr_writer :informational_entity_id - - # @!attribute [r] program_id + # @!attribute program_id # The identifier for the Program that this Account falls under. Required if you # operate more than one Program. # # @return [String, nil] optional :program_id, String - # @!parse - # # @return [String] - # attr_writer :program_id - - # @!parse - # # @param name [String] - # # @param entity_id [String] - # # @param informational_entity_id [String] - # # @param program_id [String] - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(name:, entity_id: nil, informational_entity_id: nil, program_id: nil, request_options: {}, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(name:, entity_id: nil, informational_entity_id: nil, program_id: nil, request_options: {}) + # @param name [String] + # @param entity_id [String] + # @param informational_entity_id [String] + # @param program_id [String] + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/increase/models/account_list_params.rb b/lib/increase/models/account_list_params.rb index d6158a67c..bdafaaace 100644 --- a/lib/increase/models/account_list_params.rb +++ b/lib/increase/models/account_list_params.rb @@ -4,40 +4,27 @@ module Increase module Models # @see Increase::Resources::Accounts#list class AccountListParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters - # @!attribute [r] created_at + # @!attribute created_at # # @return [Increase::Models::AccountListParams::CreatedAt, nil] optional :created_at, -> { Increase::Models::AccountListParams::CreatedAt } - # @!parse - # # @return [Increase::Models::AccountListParams::CreatedAt] - # attr_writer :created_at - - # @!attribute [r] cursor + # @!attribute cursor # Return the page of entries after this one. # # @return [String, nil] optional :cursor, String - # @!parse - # # @return [String] - # attr_writer :cursor - - # @!attribute [r] entity_id + # @!attribute entity_id # Filter Accounts for those belonging to the specified Entity. # # @return [String, nil] optional :entity_id, String - # @!parse - # # @return [String] - # attr_writer :entity_id - - # @!attribute [r] idempotency_key + # @!attribute idempotency_key # Filter records to the one with the specified `idempotency_key` you chose for # that object. This value is unique across Increase and is used to ensure that a # request is only processed once. Learn more about @@ -46,136 +33,79 @@ class AccountListParams < Increase::Internal::Type::BaseModel # @return [String, nil] optional :idempotency_key, String - # @!parse - # # @return [String] - # attr_writer :idempotency_key - - # @!attribute [r] informational_entity_id + # @!attribute informational_entity_id # Filter Accounts for those belonging to the specified Entity as informational. # # @return [String, nil] optional :informational_entity_id, String - # @!parse - # # @return [String] - # attr_writer :informational_entity_id - - # @!attribute [r] limit + # @!attribute limit # Limit the size of the list that is returned. The default (and maximum) is 100 # objects. # # @return [Integer, nil] optional :limit, Integer - # @!parse - # # @return [Integer] - # attr_writer :limit - - # @!attribute [r] program_id + # @!attribute program_id # Filter Accounts for those in a specific Program. # # @return [String, nil] optional :program_id, String - # @!parse - # # @return [String] - # attr_writer :program_id - - # @!attribute [r] status + # @!attribute status # # @return [Increase::Models::AccountListParams::Status, nil] optional :status, -> { Increase::Models::AccountListParams::Status } - # @!parse - # # @return [Increase::Models::AccountListParams::Status] - # attr_writer :status - - # @!parse - # # @param created_at [Increase::Models::AccountListParams::CreatedAt] - # # @param cursor [String] - # # @param entity_id [String] - # # @param idempotency_key [String] - # # @param informational_entity_id [String] - # # @param limit [Integer] - # # @param program_id [String] - # # @param status [Increase::Models::AccountListParams::Status] - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize( - # created_at: nil, - # cursor: nil, - # entity_id: nil, - # idempotency_key: nil, - # informational_entity_id: nil, - # limit: nil, - # program_id: nil, - # status: nil, - # request_options: {}, - # ** - # ) - # super - # end - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(created_at: nil, cursor: nil, entity_id: nil, idempotency_key: nil, informational_entity_id: nil, limit: nil, program_id: nil, status: nil, request_options: {}) + # @param created_at [Increase::Models::AccountListParams::CreatedAt] + # @param cursor [String] + # @param entity_id [String] + # @param idempotency_key [String] + # @param informational_entity_id [String] + # @param limit [Integer] + # @param program_id [String] + # @param status [Increase::Models::AccountListParams::Status] + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] class CreatedAt < Increase::Internal::Type::BaseModel - # @!attribute [r] after + # @!attribute after # Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) # timestamp. # # @return [Time, nil] optional :after, Time - # @!parse - # # @return [Time] - # attr_writer :after - - # @!attribute [r] before + # @!attribute before # Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) # timestamp. # # @return [Time, nil] optional :before, Time - # @!parse - # # @return [Time] - # attr_writer :before - - # @!attribute [r] on_or_after + # @!attribute on_or_after # Return results on or after this # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. # # @return [Time, nil] optional :on_or_after, Time - # @!parse - # # @return [Time] - # attr_writer :on_or_after - - # @!attribute [r] on_or_before + # @!attribute on_or_before # Return results on or before this # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. # # @return [Time, nil] optional :on_or_before, Time - # @!parse - # # @return [Time] - # attr_writer :on_or_before - - # @!parse - # # @param after [Time] - # # @param before [Time] - # # @param on_or_after [Time] - # # @param on_or_before [Time] - # # - # def initialize(after: nil, before: nil, on_or_after: nil, on_or_before: nil, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(after: nil, before: nil, on_or_after: nil, on_or_before: nil) + # @param after [Time] + # @param before [Time] + # @param on_or_after [Time] + # @param on_or_before [Time] end class Status < Increase::Internal::Type::BaseModel - # @!attribute [r] in_ + # @!attribute in_ # Filter Accounts for those with the specified status. For GET requests, this # should be encoded as a comma-delimited string, such as `?in=one,two,three`. # @@ -184,16 +114,8 @@ class Status < Increase::Internal::Type::BaseModel -> { Increase::Internal::Type::ArrayOf[enum: Increase::Models::AccountListParams::Status::In] }, api_name: :in - # @!parse - # # @return [Array] - # attr_writer :in_ - - # @!parse - # # @param in_ [Array] - # # - # def initialize(in_: nil, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(in_: nil) + # @param in_ [Array] module In extend Increase::Internal::Type::Enum @@ -204,11 +126,8 @@ module In # Open Accounts that are ready to use. OPEN = :open - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end diff --git a/lib/increase/models/account_number.rb b/lib/increase/models/account_number.rb index 840466663..50f2748cd 100644 --- a/lib/increase/models/account_number.rb +++ b/lib/increase/models/account_number.rb @@ -75,43 +75,24 @@ class AccountNumber < Increase::Internal::Type::BaseModel # @return [Symbol, Increase::Models::AccountNumber::Type] required :type, enum: -> { Increase::Models::AccountNumber::Type } - # @!parse - # # Each account can have multiple account and routing numbers. We recommend that - # # you use a set per vendor. This is similar to how you use different passwords for - # # different websites. Account numbers can also be used to seamlessly reconcile - # # inbound payments. Generating a unique account number per vendor ensures you - # # always know the originator of an incoming payment. - # # - # # @param id [String] - # # @param account_id [String] - # # @param account_number [String] - # # @param created_at [Time] - # # @param idempotency_key [String, nil] - # # @param inbound_ach [Increase::Models::AccountNumber::InboundACH] - # # @param inbound_checks [Increase::Models::AccountNumber::InboundChecks] - # # @param name [String] - # # @param routing_number [String] - # # @param status [Symbol, Increase::Models::AccountNumber::Status] - # # @param type [Symbol, Increase::Models::AccountNumber::Type] - # # - # def initialize( - # id:, - # account_id:, - # account_number:, - # created_at:, - # idempotency_key:, - # inbound_ach:, - # inbound_checks:, - # name:, - # routing_number:, - # status:, - # type:, - # ** - # ) - # super - # end - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(id:, account_id:, account_number:, created_at:, idempotency_key:, inbound_ach:, inbound_checks:, name:, routing_number:, status:, type:) + # Each account can have multiple account and routing numbers. We recommend that + # you use a set per vendor. This is similar to how you use different passwords for + # different websites. Account numbers can also be used to seamlessly reconcile + # inbound payments. Generating a unique account number per vendor ensures you + # always know the originator of an incoming payment. + # + # @param id [String] + # @param account_id [String] + # @param account_number [String] + # @param created_at [Time] + # @param idempotency_key [String, nil] + # @param inbound_ach [Increase::Models::AccountNumber::InboundACH] + # @param inbound_checks [Increase::Models::AccountNumber::InboundChecks] + # @param name [String] + # @param routing_number [String] + # @param status [Symbol, Increase::Models::AccountNumber::Status] + # @param type [Symbol, Increase::Models::AccountNumber::Type] # @see Increase::Models::AccountNumber#inbound_ach class InboundACH < Increase::Internal::Type::BaseModel @@ -122,14 +103,10 @@ class InboundACH < Increase::Internal::Type::BaseModel # @return [Symbol, Increase::Models::AccountNumber::InboundACH::DebitStatus] required :debit_status, enum: -> { Increase::Models::AccountNumber::InboundACH::DebitStatus } - # @!parse - # # Properties related to how this Account Number handles inbound ACH transfers. - # # - # # @param debit_status [Symbol, Increase::Models::AccountNumber::InboundACH::DebitStatus] - # # - # def initialize(debit_status:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(debit_status:) + # Properties related to how this Account Number handles inbound ACH transfers. + # + # @param debit_status [Symbol, Increase::Models::AccountNumber::InboundACH::DebitStatus] # Whether ACH debits are allowed against this Account Number. Note that they will # still be declined if this is `allowed` if the Account Number is not active. @@ -144,11 +121,8 @@ module DebitStatus # ACH Debits are blocked. BLOCKED = :blocked - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -160,15 +134,11 @@ class InboundChecks < Increase::Internal::Type::BaseModel # @return [Symbol, Increase::Models::AccountNumber::InboundChecks::Status] required :status, enum: -> { Increase::Models::AccountNumber::InboundChecks::Status } - # @!parse - # # Properties related to how this Account Number should handle inbound check - # # withdrawals. - # # - # # @param status [Symbol, Increase::Models::AccountNumber::InboundChecks::Status] - # # - # def initialize(status:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(status:) + # Properties related to how this Account Number should handle inbound check + # withdrawals. + # + # @param status [Symbol, Increase::Models::AccountNumber::InboundChecks::Status] # How Increase should process checks with this account number printed on them. # @@ -182,11 +152,8 @@ module Status # Checks with this Account Number will be processed only if they can be matched to an existing Check Transfer. CHECK_TRANSFERS_ONLY = :check_transfers_only - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -205,11 +172,8 @@ module Status # The account number is permanently disabled. CANCELED = :canceled - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # A constant representing the object's type. For this resource it will always be @@ -221,11 +185,8 @@ module Type ACCOUNT_NUMBER = :account_number - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end diff --git a/lib/increase/models/account_number_create_params.rb b/lib/increase/models/account_number_create_params.rb index b97f4a992..913f4855c 100644 --- a/lib/increase/models/account_number_create_params.rb +++ b/lib/increase/models/account_number_create_params.rb @@ -4,8 +4,7 @@ module Increase module Models # @see Increase::Resources::AccountNumbers#create class AccountNumberCreateParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters # @!attribute account_id @@ -20,37 +19,25 @@ class AccountNumberCreateParams < Increase::Internal::Type::BaseModel # @return [String] required :name, String - # @!attribute [r] inbound_ach + # @!attribute inbound_ach # Options related to how this Account Number should handle inbound ACH transfers. # # @return [Increase::Models::AccountNumberCreateParams::InboundACH, nil] optional :inbound_ach, -> { Increase::Models::AccountNumberCreateParams::InboundACH } - # @!parse - # # @return [Increase::Models::AccountNumberCreateParams::InboundACH] - # attr_writer :inbound_ach - - # @!attribute [r] inbound_checks + # @!attribute inbound_checks # Options related to how this Account Number should handle inbound check # withdrawals. # # @return [Increase::Models::AccountNumberCreateParams::InboundChecks, nil] optional :inbound_checks, -> { Increase::Models::AccountNumberCreateParams::InboundChecks } - # @!parse - # # @return [Increase::Models::AccountNumberCreateParams::InboundChecks] - # attr_writer :inbound_checks - - # @!parse - # # @param account_id [String] - # # @param name [String] - # # @param inbound_ach [Increase::Models::AccountNumberCreateParams::InboundACH] - # # @param inbound_checks [Increase::Models::AccountNumberCreateParams::InboundChecks] - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(account_id:, name:, inbound_ach: nil, inbound_checks: nil, request_options: {}, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(account_id:, name:, inbound_ach: nil, inbound_checks: nil, request_options: {}) + # @param account_id [String] + # @param name [String] + # @param inbound_ach [Increase::Models::AccountNumberCreateParams::InboundACH] + # @param inbound_checks [Increase::Models::AccountNumberCreateParams::InboundChecks] + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] class InboundACH < Increase::Internal::Type::BaseModel # @!attribute debit_status @@ -61,14 +48,10 @@ class InboundACH < Increase::Internal::Type::BaseModel # @return [Symbol, Increase::Models::AccountNumberCreateParams::InboundACH::DebitStatus] required :debit_status, enum: -> { Increase::Models::AccountNumberCreateParams::InboundACH::DebitStatus } - # @!parse - # # Options related to how this Account Number should handle inbound ACH transfers. - # # - # # @param debit_status [Symbol, Increase::Models::AccountNumberCreateParams::InboundACH::DebitStatus] - # # - # def initialize(debit_status:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(debit_status:) + # Options related to how this Account Number should handle inbound ACH transfers. + # + # @param debit_status [Symbol, Increase::Models::AccountNumberCreateParams::InboundACH::DebitStatus] # Whether ACH debits are allowed against this Account Number. Note that ACH debits # will be declined if this is `allowed` but the Account Number is not active. If @@ -84,11 +67,8 @@ module DebitStatus # ACH Debits are blocked. BLOCKED = :blocked - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -100,15 +80,11 @@ class InboundChecks < Increase::Internal::Type::BaseModel # @return [Symbol, Increase::Models::AccountNumberCreateParams::InboundChecks::Status] required :status, enum: -> { Increase::Models::AccountNumberCreateParams::InboundChecks::Status } - # @!parse - # # Options related to how this Account Number should handle inbound check - # # withdrawals. - # # - # # @param status [Symbol, Increase::Models::AccountNumberCreateParams::InboundChecks::Status] - # # - # def initialize(status:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(status:) + # Options related to how this Account Number should handle inbound check + # withdrawals. + # + # @param status [Symbol, Increase::Models::AccountNumberCreateParams::InboundChecks::Status] # How Increase should process checks with this account number printed on them. If # you do not specify this field, the default is `check_transfers_only`. @@ -123,11 +99,8 @@ module Status # Checks with this Account Number will be processed only if they can be matched to an existing Check Transfer. CHECK_TRANSFERS_ONLY = :check_transfers_only - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end diff --git a/lib/increase/models/account_number_list_params.rb b/lib/increase/models/account_number_list_params.rb index 94eff4c70..a10dde1d1 100644 --- a/lib/increase/models/account_number_list_params.rb +++ b/lib/increase/models/account_number_list_params.rb @@ -4,49 +4,32 @@ module Increase module Models # @see Increase::Resources::AccountNumbers#list class AccountNumberListParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters - # @!attribute [r] account_id + # @!attribute account_id # Filter Account Numbers to those belonging to the specified Account. # # @return [String, nil] optional :account_id, String - # @!parse - # # @return [String] - # attr_writer :account_id - - # @!attribute [r] ach_debit_status + # @!attribute ach_debit_status # # @return [Increase::Models::AccountNumberListParams::ACHDebitStatus, nil] optional :ach_debit_status, -> { Increase::Models::AccountNumberListParams::ACHDebitStatus } - # @!parse - # # @return [Increase::Models::AccountNumberListParams::ACHDebitStatus] - # attr_writer :ach_debit_status - - # @!attribute [r] created_at + # @!attribute created_at # # @return [Increase::Models::AccountNumberListParams::CreatedAt, nil] optional :created_at, -> { Increase::Models::AccountNumberListParams::CreatedAt } - # @!parse - # # @return [Increase::Models::AccountNumberListParams::CreatedAt] - # attr_writer :created_at - - # @!attribute [r] cursor + # @!attribute cursor # Return the page of entries after this one. # # @return [String, nil] optional :cursor, String - # @!parse - # # @return [String] - # attr_writer :cursor - - # @!attribute [r] idempotency_key + # @!attribute idempotency_key # Filter records to the one with the specified `idempotency_key` you chose for # that object. This value is unique across Increase and is used to ensure that a # request is only processed once. Learn more about @@ -55,58 +38,30 @@ class AccountNumberListParams < Increase::Internal::Type::BaseModel # @return [String, nil] optional :idempotency_key, String - # @!parse - # # @return [String] - # attr_writer :idempotency_key - - # @!attribute [r] limit + # @!attribute limit # Limit the size of the list that is returned. The default (and maximum) is 100 # objects. # # @return [Integer, nil] optional :limit, Integer - # @!parse - # # @return [Integer] - # attr_writer :limit - - # @!attribute [r] status + # @!attribute status # # @return [Increase::Models::AccountNumberListParams::Status, nil] optional :status, -> { Increase::Models::AccountNumberListParams::Status } - # @!parse - # # @return [Increase::Models::AccountNumberListParams::Status] - # attr_writer :status - - # @!parse - # # @param account_id [String] - # # @param ach_debit_status [Increase::Models::AccountNumberListParams::ACHDebitStatus] - # # @param created_at [Increase::Models::AccountNumberListParams::CreatedAt] - # # @param cursor [String] - # # @param idempotency_key [String] - # # @param limit [Integer] - # # @param status [Increase::Models::AccountNumberListParams::Status] - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize( - # account_id: nil, - # ach_debit_status: nil, - # created_at: nil, - # cursor: nil, - # idempotency_key: nil, - # limit: nil, - # status: nil, - # request_options: {}, - # ** - # ) - # super - # end - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(account_id: nil, ach_debit_status: nil, created_at: nil, cursor: nil, idempotency_key: nil, limit: nil, status: nil, request_options: {}) + # @param account_id [String] + # @param ach_debit_status [Increase::Models::AccountNumberListParams::ACHDebitStatus] + # @param created_at [Increase::Models::AccountNumberListParams::CreatedAt] + # @param cursor [String] + # @param idempotency_key [String] + # @param limit [Integer] + # @param status [Increase::Models::AccountNumberListParams::Status] + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] class ACHDebitStatus < Increase::Internal::Type::BaseModel - # @!attribute [r] in_ + # @!attribute in_ # The ACH Debit status to retrieve Account Numbers for. For GET requests, this # should be encoded as a comma-delimited string, such as `?in=one,two,three`. # @@ -115,16 +70,8 @@ class ACHDebitStatus < Increase::Internal::Type::BaseModel -> { Increase::Internal::Type::ArrayOf[enum: Increase::Models::AccountNumberListParams::ACHDebitStatus::In] }, api_name: :in - # @!parse - # # @return [Array] - # attr_writer :in_ - - # @!parse - # # @param in_ [Array] - # # - # def initialize(in_: nil, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(in_: nil) + # @param in_ [Array] module In extend Increase::Internal::Type::Enum @@ -135,72 +82,49 @@ module In # ACH Debits are blocked. BLOCKED = :blocked - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end class CreatedAt < Increase::Internal::Type::BaseModel - # @!attribute [r] after + # @!attribute after # Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) # timestamp. # # @return [Time, nil] optional :after, Time - # @!parse - # # @return [Time] - # attr_writer :after - - # @!attribute [r] before + # @!attribute before # Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) # timestamp. # # @return [Time, nil] optional :before, Time - # @!parse - # # @return [Time] - # attr_writer :before - - # @!attribute [r] on_or_after + # @!attribute on_or_after # Return results on or after this # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. # # @return [Time, nil] optional :on_or_after, Time - # @!parse - # # @return [Time] - # attr_writer :on_or_after - - # @!attribute [r] on_or_before + # @!attribute on_or_before # Return results on or before this # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. # # @return [Time, nil] optional :on_or_before, Time - # @!parse - # # @return [Time] - # attr_writer :on_or_before - - # @!parse - # # @param after [Time] - # # @param before [Time] - # # @param on_or_after [Time] - # # @param on_or_before [Time] - # # - # def initialize(after: nil, before: nil, on_or_after: nil, on_or_before: nil, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(after: nil, before: nil, on_or_after: nil, on_or_before: nil) + # @param after [Time] + # @param before [Time] + # @param on_or_after [Time] + # @param on_or_before [Time] end class Status < Increase::Internal::Type::BaseModel - # @!attribute [r] in_ + # @!attribute in_ # The status to retrieve Account Numbers for. For GET requests, this should be # encoded as a comma-delimited string, such as `?in=one,two,three`. # @@ -209,16 +133,8 @@ class Status < Increase::Internal::Type::BaseModel -> { Increase::Internal::Type::ArrayOf[enum: Increase::Models::AccountNumberListParams::Status::In] }, api_name: :in - # @!parse - # # @return [Array] - # attr_writer :in_ - - # @!parse - # # @param in_ [Array] - # # - # def initialize(in_: nil, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(in_: nil) + # @param in_ [Array] module In extend Increase::Internal::Type::Enum @@ -232,11 +148,8 @@ module In # The account number is permanently disabled. CANCELED = :canceled - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end diff --git a/lib/increase/models/account_number_retrieve_params.rb b/lib/increase/models/account_number_retrieve_params.rb index eaa3cb2e6..fe09657d1 100644 --- a/lib/increase/models/account_number_retrieve_params.rb +++ b/lib/increase/models/account_number_retrieve_params.rb @@ -4,16 +4,11 @@ module Increase module Models # @see Increase::Resources::AccountNumbers#retrieve class AccountNumberRetrieveParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters - # @!parse - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(request_options: {}, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(request_options: {}) + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/increase/models/account_number_update_params.rb b/lib/increase/models/account_number_update_params.rb index d193472db..517ca4fce 100644 --- a/lib/increase/models/account_number_update_params.rb +++ b/lib/increase/models/account_number_update_params.rb @@ -4,82 +4,53 @@ module Increase module Models # @see Increase::Resources::AccountNumbers#update class AccountNumberUpdateParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters - # @!attribute [r] inbound_ach + # @!attribute inbound_ach # Options related to how this Account Number handles inbound ACH transfers. # # @return [Increase::Models::AccountNumberUpdateParams::InboundACH, nil] optional :inbound_ach, -> { Increase::Models::AccountNumberUpdateParams::InboundACH } - # @!parse - # # @return [Increase::Models::AccountNumberUpdateParams::InboundACH] - # attr_writer :inbound_ach - - # @!attribute [r] inbound_checks + # @!attribute inbound_checks # Options related to how this Account Number should handle inbound check # withdrawals. # # @return [Increase::Models::AccountNumberUpdateParams::InboundChecks, nil] optional :inbound_checks, -> { Increase::Models::AccountNumberUpdateParams::InboundChecks } - # @!parse - # # @return [Increase::Models::AccountNumberUpdateParams::InboundChecks] - # attr_writer :inbound_checks - - # @!attribute [r] name + # @!attribute name # The name you choose for the Account Number. # # @return [String, nil] optional :name, String - # @!parse - # # @return [String] - # attr_writer :name - - # @!attribute [r] status + # @!attribute status # This indicates if transfers can be made to the Account Number. # # @return [Symbol, Increase::Models::AccountNumberUpdateParams::Status, nil] optional :status, enum: -> { Increase::Models::AccountNumberUpdateParams::Status } - # @!parse - # # @return [Symbol, Increase::Models::AccountNumberUpdateParams::Status] - # attr_writer :status - - # @!parse - # # @param inbound_ach [Increase::Models::AccountNumberUpdateParams::InboundACH] - # # @param inbound_checks [Increase::Models::AccountNumberUpdateParams::InboundChecks] - # # @param name [String] - # # @param status [Symbol, Increase::Models::AccountNumberUpdateParams::Status] - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(inbound_ach: nil, inbound_checks: nil, name: nil, status: nil, request_options: {}, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(inbound_ach: nil, inbound_checks: nil, name: nil, status: nil, request_options: {}) + # @param inbound_ach [Increase::Models::AccountNumberUpdateParams::InboundACH] + # @param inbound_checks [Increase::Models::AccountNumberUpdateParams::InboundChecks] + # @param name [String] + # @param status [Symbol, Increase::Models::AccountNumberUpdateParams::Status] + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] class InboundACH < Increase::Internal::Type::BaseModel - # @!attribute [r] debit_status + # @!attribute debit_status # Whether ACH debits are allowed against this Account Number. Note that ACH debits # will be declined if this is `allowed` but the Account Number is not active. # # @return [Symbol, Increase::Models::AccountNumberUpdateParams::InboundACH::DebitStatus, nil] optional :debit_status, enum: -> { Increase::Models::AccountNumberUpdateParams::InboundACH::DebitStatus } - # @!parse - # # @return [Symbol, Increase::Models::AccountNumberUpdateParams::InboundACH::DebitStatus] - # attr_writer :debit_status - - # @!parse - # # Options related to how this Account Number handles inbound ACH transfers. - # # - # # @param debit_status [Symbol, Increase::Models::AccountNumberUpdateParams::InboundACH::DebitStatus] - # # - # def initialize(debit_status: nil, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(debit_status: nil) + # Options related to how this Account Number handles inbound ACH transfers. + # + # @param debit_status [Symbol, Increase::Models::AccountNumberUpdateParams::InboundACH::DebitStatus] # Whether ACH debits are allowed against this Account Number. Note that ACH debits # will be declined if this is `allowed` but the Account Number is not active. @@ -94,11 +65,8 @@ module DebitStatus # ACH Debits are blocked. BLOCKED = :blocked - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -109,15 +77,11 @@ class InboundChecks < Increase::Internal::Type::BaseModel # @return [Symbol, Increase::Models::AccountNumberUpdateParams::InboundChecks::Status] required :status, enum: -> { Increase::Models::AccountNumberUpdateParams::InboundChecks::Status } - # @!parse - # # Options related to how this Account Number should handle inbound check - # # withdrawals. - # # - # # @param status [Symbol, Increase::Models::AccountNumberUpdateParams::InboundChecks::Status] - # # - # def initialize(status:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(status:) + # Options related to how this Account Number should handle inbound check + # withdrawals. + # + # @param status [Symbol, Increase::Models::AccountNumberUpdateParams::InboundChecks::Status] # How Increase should process checks with this account number printed on them. # @@ -131,11 +95,8 @@ module Status # Checks with this Account Number will be processed only if they can be matched to an existing Check Transfer. CHECK_TRANSFERS_ONLY = :check_transfers_only - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -152,11 +113,8 @@ module Status # The account number is permanently disabled. CANCELED = :canceled - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end diff --git a/lib/increase/models/account_retrieve_params.rb b/lib/increase/models/account_retrieve_params.rb index 88bc4e4f8..80d7310ee 100644 --- a/lib/increase/models/account_retrieve_params.rb +++ b/lib/increase/models/account_retrieve_params.rb @@ -4,16 +4,11 @@ module Increase module Models # @see Increase::Resources::Accounts#retrieve class AccountRetrieveParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters - # @!parse - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(request_options: {}, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(request_options: {}) + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/increase/models/account_statement.rb b/lib/increase/models/account_statement.rb index 27687ade6..b59a91283 100644 --- a/lib/increase/models/account_statement.rb +++ b/lib/increase/models/account_statement.rb @@ -62,37 +62,20 @@ class AccountStatement < Increase::Internal::Type::BaseModel # @return [Symbol, Increase::Models::AccountStatement::Type] required :type, enum: -> { Increase::Models::AccountStatement::Type } - # @!parse - # # Account Statements are generated monthly for every active Account. You can - # # access the statement's data via the API or retrieve a PDF with its details via - # # its associated File. - # # - # # @param id [String] - # # @param account_id [String] - # # @param created_at [Time] - # # @param ending_balance [Integer] - # # @param file_id [String] - # # @param starting_balance [Integer] - # # @param statement_period_end [Time] - # # @param statement_period_start [Time] - # # @param type [Symbol, Increase::Models::AccountStatement::Type] - # # - # def initialize( - # id:, - # account_id:, - # created_at:, - # ending_balance:, - # file_id:, - # starting_balance:, - # statement_period_end:, - # statement_period_start:, - # type:, - # ** - # ) - # super - # end - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(id:, account_id:, created_at:, ending_balance:, file_id:, starting_balance:, statement_period_end:, statement_period_start:, type:) + # Account Statements are generated monthly for every active Account. You can + # access the statement's data via the API or retrieve a PDF with its details via + # its associated File. + # + # @param id [String] + # @param account_id [String] + # @param created_at [Time] + # @param ending_balance [Integer] + # @param file_id [String] + # @param starting_balance [Integer] + # @param statement_period_end [Time] + # @param statement_period_start [Time] + # @param type [Symbol, Increase::Models::AccountStatement::Type] # A constant representing the object's type. For this resource it will always be # `account_statement`. @@ -103,11 +86,8 @@ module Type ACCOUNT_STATEMENT = :account_statement - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end diff --git a/lib/increase/models/account_statement_list_params.rb b/lib/increase/models/account_statement_list_params.rb index 2bc467c39..4a6f45bed 100644 --- a/lib/increase/models/account_statement_list_params.rb +++ b/lib/increase/models/account_statement_list_params.rb @@ -4,116 +4,75 @@ module Increase module Models # @see Increase::Resources::AccountStatements#list class AccountStatementListParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters - # @!attribute [r] account_id + # @!attribute account_id # Filter Account Statements to those belonging to the specified Account. # # @return [String, nil] optional :account_id, String - # @!parse - # # @return [String] - # attr_writer :account_id - - # @!attribute [r] cursor + # @!attribute cursor # Return the page of entries after this one. # # @return [String, nil] optional :cursor, String - # @!parse - # # @return [String] - # attr_writer :cursor - - # @!attribute [r] limit + # @!attribute limit # Limit the size of the list that is returned. The default (and maximum) is 100 # objects. # # @return [Integer, nil] optional :limit, Integer - # @!parse - # # @return [Integer] - # attr_writer :limit - - # @!attribute [r] statement_period_start + # @!attribute statement_period_start # # @return [Increase::Models::AccountStatementListParams::StatementPeriodStart, nil] optional :statement_period_start, -> { Increase::Models::AccountStatementListParams::StatementPeriodStart } - # @!parse - # # @return [Increase::Models::AccountStatementListParams::StatementPeriodStart] - # attr_writer :statement_period_start - - # @!parse - # # @param account_id [String] - # # @param cursor [String] - # # @param limit [Integer] - # # @param statement_period_start [Increase::Models::AccountStatementListParams::StatementPeriodStart] - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(account_id: nil, cursor: nil, limit: nil, statement_period_start: nil, request_options: {}, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(account_id: nil, cursor: nil, limit: nil, statement_period_start: nil, request_options: {}) + # @param account_id [String] + # @param cursor [String] + # @param limit [Integer] + # @param statement_period_start [Increase::Models::AccountStatementListParams::StatementPeriodStart] + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] class StatementPeriodStart < Increase::Internal::Type::BaseModel - # @!attribute [r] after + # @!attribute after # Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) # timestamp. # # @return [Time, nil] optional :after, Time - # @!parse - # # @return [Time] - # attr_writer :after - - # @!attribute [r] before + # @!attribute before # Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) # timestamp. # # @return [Time, nil] optional :before, Time - # @!parse - # # @return [Time] - # attr_writer :before - - # @!attribute [r] on_or_after + # @!attribute on_or_after # Return results on or after this # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. # # @return [Time, nil] optional :on_or_after, Time - # @!parse - # # @return [Time] - # attr_writer :on_or_after - - # @!attribute [r] on_or_before + # @!attribute on_or_before # Return results on or before this # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. # # @return [Time, nil] optional :on_or_before, Time - # @!parse - # # @return [Time] - # attr_writer :on_or_before - - # @!parse - # # @param after [Time] - # # @param before [Time] - # # @param on_or_after [Time] - # # @param on_or_before [Time] - # # - # def initialize(after: nil, before: nil, on_or_after: nil, on_or_before: nil, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(after: nil, before: nil, on_or_after: nil, on_or_before: nil) + # @param after [Time] + # @param before [Time] + # @param on_or_after [Time] + # @param on_or_before [Time] end end end diff --git a/lib/increase/models/account_statement_retrieve_params.rb b/lib/increase/models/account_statement_retrieve_params.rb index 30a6be55f..23ae30d05 100644 --- a/lib/increase/models/account_statement_retrieve_params.rb +++ b/lib/increase/models/account_statement_retrieve_params.rb @@ -4,16 +4,11 @@ module Increase module Models # @see Increase::Resources::AccountStatements#retrieve class AccountStatementRetrieveParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters - # @!parse - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(request_options: {}, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(request_options: {}) + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/increase/models/account_transfer.rb b/lib/increase/models/account_transfer.rb index 31b444fc0..706c02e0c 100644 --- a/lib/increase/models/account_transfer.rb +++ b/lib/increase/models/account_transfer.rb @@ -117,51 +117,26 @@ class AccountTransfer < Increase::Internal::Type::BaseModel # @return [Symbol, Increase::Models::AccountTransfer::Type] required :type, enum: -> { Increase::Models::AccountTransfer::Type } - # @!parse - # # Account transfers move funds between your own accounts at Increase. - # # - # # @param id [String] - # # @param account_id [String] - # # @param amount [Integer] - # # @param approval [Increase::Models::AccountTransfer::Approval, nil] - # # @param cancellation [Increase::Models::AccountTransfer::Cancellation, nil] - # # @param created_at [Time] - # # @param created_by [Increase::Models::AccountTransfer::CreatedBy, nil] - # # @param currency [Symbol, Increase::Models::AccountTransfer::Currency] - # # @param description [String] - # # @param destination_account_id [String] - # # @param destination_transaction_id [String, nil] - # # @param idempotency_key [String, nil] - # # @param network [Symbol, Increase::Models::AccountTransfer::Network] - # # @param pending_transaction_id [String, nil] - # # @param status [Symbol, Increase::Models::AccountTransfer::Status] - # # @param transaction_id [String, nil] - # # @param type [Symbol, Increase::Models::AccountTransfer::Type] - # # - # def initialize( - # id:, - # account_id:, - # amount:, - # approval:, - # cancellation:, - # created_at:, - # created_by:, - # currency:, - # description:, - # destination_account_id:, - # destination_transaction_id:, - # idempotency_key:, - # network:, - # pending_transaction_id:, - # status:, - # transaction_id:, - # type:, - # ** - # ) - # super - # end - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(id:, account_id:, amount:, approval:, cancellation:, created_at:, created_by:, currency:, description:, destination_account_id:, destination_transaction_id:, idempotency_key:, network:, pending_transaction_id:, status:, transaction_id:, type:) + # Account transfers move funds between your own accounts at Increase. + # + # @param id [String] + # @param account_id [String] + # @param amount [Integer] + # @param approval [Increase::Models::AccountTransfer::Approval, nil] + # @param cancellation [Increase::Models::AccountTransfer::Cancellation, nil] + # @param created_at [Time] + # @param created_by [Increase::Models::AccountTransfer::CreatedBy, nil] + # @param currency [Symbol, Increase::Models::AccountTransfer::Currency] + # @param description [String] + # @param destination_account_id [String] + # @param destination_transaction_id [String, nil] + # @param idempotency_key [String, nil] + # @param network [Symbol, Increase::Models::AccountTransfer::Network] + # @param pending_transaction_id [String, nil] + # @param status [Symbol, Increase::Models::AccountTransfer::Status] + # @param transaction_id [String, nil] + # @param type [Symbol, Increase::Models::AccountTransfer::Type] # @see Increase::Models::AccountTransfer#approval class Approval < Increase::Internal::Type::BaseModel @@ -179,16 +154,12 @@ class Approval < Increase::Internal::Type::BaseModel # @return [String, nil] required :approved_by, String, nil?: true - # @!parse - # # If your account requires approvals for transfers and the transfer was approved, - # # this will contain details of the approval. - # # - # # @param approved_at [Time] - # # @param approved_by [String, nil] - # # - # def initialize(approved_at:, approved_by:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(approved_at:, approved_by:) + # If your account requires approvals for transfers and the transfer was approved, + # this will contain details of the approval. + # + # @param approved_at [Time] + # @param approved_by [String, nil] end # @see Increase::Models::AccountTransfer#cancellation @@ -207,16 +178,12 @@ class Cancellation < Increase::Internal::Type::BaseModel # @return [String, nil] required :canceled_by, String, nil?: true - # @!parse - # # If your account requires approvals for transfers and the transfer was not - # # approved, this will contain details of the cancellation. - # # - # # @param canceled_at [Time] - # # @param canceled_by [String, nil] - # # - # def initialize(canceled_at:, canceled_by:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(canceled_at:, canceled_by:) + # If your account requires approvals for transfers and the transfer was not + # approved, this will contain details of the cancellation. + # + # @param canceled_at [Time] + # @param canceled_by [String, nil] end # @see Increase::Models::AccountTransfer#created_by @@ -247,17 +214,13 @@ class CreatedBy < Increase::Internal::Type::BaseModel # @return [Increase::Models::AccountTransfer::CreatedBy::User, nil] required :user, -> { Increase::Models::AccountTransfer::CreatedBy::User }, nil?: true - # @!parse - # # What object created the transfer, either via the API or the dashboard. - # # - # # @param api_key [Increase::Models::AccountTransfer::CreatedBy::APIKey, nil] - # # @param category [Symbol, Increase::Models::AccountTransfer::CreatedBy::Category] - # # @param oauth_application [Increase::Models::AccountTransfer::CreatedBy::OAuthApplication, nil] - # # @param user [Increase::Models::AccountTransfer::CreatedBy::User, nil] - # # - # def initialize(api_key:, category:, oauth_application:, user:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(api_key:, category:, oauth_application:, user:) + # What object created the transfer, either via the API or the dashboard. + # + # @param api_key [Increase::Models::AccountTransfer::CreatedBy::APIKey, nil] + # @param category [Symbol, Increase::Models::AccountTransfer::CreatedBy::Category] + # @param oauth_application [Increase::Models::AccountTransfer::CreatedBy::OAuthApplication, nil] + # @param user [Increase::Models::AccountTransfer::CreatedBy::User, nil] # @see Increase::Models::AccountTransfer::CreatedBy#api_key class APIKey < Increase::Internal::Type::BaseModel @@ -267,14 +230,10 @@ class APIKey < Increase::Internal::Type::BaseModel # @return [String, nil] required :description, String, nil?: true - # @!parse - # # If present, details about the API key that created the transfer. - # # - # # @param description [String, nil] - # # - # def initialize(description:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(description:) + # If present, details about the API key that created the transfer. + # + # @param description [String, nil] end # The type of object that created this transfer. @@ -292,11 +251,8 @@ module Category # A User in the Increase dashboard. Details will be under the `user` object. USER = :user - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Increase::Models::AccountTransfer::CreatedBy#oauth_application @@ -307,14 +263,10 @@ class OAuthApplication < Increase::Internal::Type::BaseModel # @return [String] required :name, String - # @!parse - # # If present, details about the OAuth Application that created the transfer. - # # - # # @param name [String] - # # - # def initialize(name:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(name:) + # If present, details about the OAuth Application that created the transfer. + # + # @param name [String] end # @see Increase::Models::AccountTransfer::CreatedBy#user @@ -325,14 +277,10 @@ class User < Increase::Internal::Type::BaseModel # @return [String] required :email, String - # @!parse - # # If present, details about the User that created the transfer. - # # - # # @param email [String] - # # - # def initialize(email:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(email:) + # If present, details about the User that created the transfer. + # + # @param email [String] end end @@ -361,11 +309,8 @@ module Currency # US Dollar (USD) USD = :USD - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # The transfer's network. @@ -376,11 +321,8 @@ module Network ACCOUNT = :account - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # The lifecycle status of the transfer. @@ -398,11 +340,8 @@ module Status # The transfer has been completed. COMPLETE = :complete - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # A constant representing the object's type. For this resource it will always be @@ -414,11 +353,8 @@ module Type ACCOUNT_TRANSFER = :account_transfer - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end diff --git a/lib/increase/models/account_transfer_approve_params.rb b/lib/increase/models/account_transfer_approve_params.rb index 9736d831b..0a920e2b5 100644 --- a/lib/increase/models/account_transfer_approve_params.rb +++ b/lib/increase/models/account_transfer_approve_params.rb @@ -4,16 +4,11 @@ module Increase module Models # @see Increase::Resources::AccountTransfers#approve class AccountTransferApproveParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters - # @!parse - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(request_options: {}, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(request_options: {}) + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/increase/models/account_transfer_cancel_params.rb b/lib/increase/models/account_transfer_cancel_params.rb index 2ff19273f..a62e38ff0 100644 --- a/lib/increase/models/account_transfer_cancel_params.rb +++ b/lib/increase/models/account_transfer_cancel_params.rb @@ -4,16 +4,11 @@ module Increase module Models # @see Increase::Resources::AccountTransfers#cancel class AccountTransferCancelParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters - # @!parse - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(request_options: {}, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(request_options: {}) + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/increase/models/account_transfer_create_params.rb b/lib/increase/models/account_transfer_create_params.rb index 42537a66a..acbddeaac 100644 --- a/lib/increase/models/account_transfer_create_params.rb +++ b/lib/increase/models/account_transfer_create_params.rb @@ -4,8 +4,7 @@ module Increase module Models # @see Increase::Resources::AccountTransfers#create class AccountTransferCreateParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters # @!attribute account_id @@ -33,37 +32,19 @@ class AccountTransferCreateParams < Increase::Internal::Type::BaseModel # @return [String] required :destination_account_id, String - # @!attribute [r] require_approval + # @!attribute require_approval # Whether the transfer requires explicit approval via the dashboard or API. # # @return [Boolean, nil] optional :require_approval, Increase::Internal::Type::Boolean - # @!parse - # # @return [Boolean] - # attr_writer :require_approval - - # @!parse - # # @param account_id [String] - # # @param amount [Integer] - # # @param description [String] - # # @param destination_account_id [String] - # # @param require_approval [Boolean] - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize( - # account_id:, - # amount:, - # description:, - # destination_account_id:, - # require_approval: nil, - # request_options: {}, - # ** - # ) - # super - # end - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(account_id:, amount:, description:, destination_account_id:, require_approval: nil, request_options: {}) + # @param account_id [String] + # @param amount [Integer] + # @param description [String] + # @param destination_account_id [String] + # @param require_approval [Boolean] + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/increase/models/account_transfer_list_params.rb b/lib/increase/models/account_transfer_list_params.rb index 5d412f934..483f1e9bf 100644 --- a/lib/increase/models/account_transfer_list_params.rb +++ b/lib/increase/models/account_transfer_list_params.rb @@ -4,40 +4,27 @@ module Increase module Models # @see Increase::Resources::AccountTransfers#list class AccountTransferListParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters - # @!attribute [r] account_id + # @!attribute account_id # Filter Account Transfers to those that originated from the specified Account. # # @return [String, nil] optional :account_id, String - # @!parse - # # @return [String] - # attr_writer :account_id - - # @!attribute [r] created_at + # @!attribute created_at # # @return [Increase::Models::AccountTransferListParams::CreatedAt, nil] optional :created_at, -> { Increase::Models::AccountTransferListParams::CreatedAt } - # @!parse - # # @return [Increase::Models::AccountTransferListParams::CreatedAt] - # attr_writer :created_at - - # @!attribute [r] cursor + # @!attribute cursor # Return the page of entries after this one. # # @return [String, nil] optional :cursor, String - # @!parse - # # @return [String] - # attr_writer :cursor - - # @!attribute [r] idempotency_key + # @!attribute idempotency_key # Filter records to the one with the specified `idempotency_key` you chose for # that object. This value is unique across Increase and is used to ensure that a # request is only processed once. Learn more about @@ -46,87 +33,55 @@ class AccountTransferListParams < Increase::Internal::Type::BaseModel # @return [String, nil] optional :idempotency_key, String - # @!parse - # # @return [String] - # attr_writer :idempotency_key - - # @!attribute [r] limit + # @!attribute limit # Limit the size of the list that is returned. The default (and maximum) is 100 # objects. # # @return [Integer, nil] optional :limit, Integer - # @!parse - # # @return [Integer] - # attr_writer :limit - - # @!parse - # # @param account_id [String] - # # @param created_at [Increase::Models::AccountTransferListParams::CreatedAt] - # # @param cursor [String] - # # @param idempotency_key [String] - # # @param limit [Integer] - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(account_id: nil, created_at: nil, cursor: nil, idempotency_key: nil, limit: nil, request_options: {}, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(account_id: nil, created_at: nil, cursor: nil, idempotency_key: nil, limit: nil, request_options: {}) + # @param account_id [String] + # @param created_at [Increase::Models::AccountTransferListParams::CreatedAt] + # @param cursor [String] + # @param idempotency_key [String] + # @param limit [Integer] + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] class CreatedAt < Increase::Internal::Type::BaseModel - # @!attribute [r] after + # @!attribute after # Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) # timestamp. # # @return [Time, nil] optional :after, Time - # @!parse - # # @return [Time] - # attr_writer :after - - # @!attribute [r] before + # @!attribute before # Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) # timestamp. # # @return [Time, nil] optional :before, Time - # @!parse - # # @return [Time] - # attr_writer :before - - # @!attribute [r] on_or_after + # @!attribute on_or_after # Return results on or after this # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. # # @return [Time, nil] optional :on_or_after, Time - # @!parse - # # @return [Time] - # attr_writer :on_or_after - - # @!attribute [r] on_or_before + # @!attribute on_or_before # Return results on or before this # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. # # @return [Time, nil] optional :on_or_before, Time - # @!parse - # # @return [Time] - # attr_writer :on_or_before - - # @!parse - # # @param after [Time] - # # @param before [Time] - # # @param on_or_after [Time] - # # @param on_or_before [Time] - # # - # def initialize(after: nil, before: nil, on_or_after: nil, on_or_before: nil, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(after: nil, before: nil, on_or_after: nil, on_or_before: nil) + # @param after [Time] + # @param before [Time] + # @param on_or_after [Time] + # @param on_or_before [Time] end end end diff --git a/lib/increase/models/account_transfer_retrieve_params.rb b/lib/increase/models/account_transfer_retrieve_params.rb index a22a27095..e92870296 100644 --- a/lib/increase/models/account_transfer_retrieve_params.rb +++ b/lib/increase/models/account_transfer_retrieve_params.rb @@ -4,16 +4,11 @@ module Increase module Models # @see Increase::Resources::AccountTransfers#retrieve class AccountTransferRetrieveParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters - # @!parse - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(request_options: {}, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(request_options: {}) + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/increase/models/account_update_params.rb b/lib/increase/models/account_update_params.rb index 889e1308d..4560bd0aa 100644 --- a/lib/increase/models/account_update_params.rb +++ b/lib/increase/models/account_update_params.rb @@ -4,27 +4,18 @@ module Increase module Models # @see Increase::Resources::Accounts#update class AccountUpdateParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters - # @!attribute [r] name + # @!attribute name # The new name of the Account. # # @return [String, nil] optional :name, String - # @!parse - # # @return [String] - # attr_writer :name - - # @!parse - # # @param name [String] - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(name: nil, request_options: {}, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(name: nil, request_options: {}) + # @param name [String] + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/increase/models/ach_prenotification.rb b/lib/increase/models/ach_prenotification.rb index cc9a68a76..efdd74b21 100644 --- a/lib/increase/models/ach_prenotification.rb +++ b/lib/increase/models/ach_prenotification.rb @@ -110,50 +110,26 @@ class ACHPrenotification < Increase::Internal::Type::BaseModel # @return [Symbol, Increase::Models::ACHPrenotification::Type] required :type, enum: -> { Increase::Models::ACHPrenotification::Type } - # @!parse - # # ACH Prenotifications are one way you can verify account and routing numbers by - # # Automated Clearing House (ACH). - # # - # # @param id [String] - # # @param account_number [String] - # # @param addendum [String, nil] - # # @param company_descriptive_date [String, nil] - # # @param company_discretionary_data [String, nil] - # # @param company_entry_description [String, nil] - # # @param company_name [String, nil] - # # @param created_at [Time] - # # @param credit_debit_indicator [Symbol, Increase::Models::ACHPrenotification::CreditDebitIndicator, nil] - # # @param effective_date [Time, nil] - # # @param idempotency_key [String, nil] - # # @param notifications_of_change [Array] - # # @param prenotification_return [Increase::Models::ACHPrenotification::PrenotificationReturn, nil] - # # @param routing_number [String] - # # @param status [Symbol, Increase::Models::ACHPrenotification::Status] - # # @param type [Symbol, Increase::Models::ACHPrenotification::Type] - # # - # def initialize( - # id:, - # account_number:, - # addendum:, - # company_descriptive_date:, - # company_discretionary_data:, - # company_entry_description:, - # company_name:, - # created_at:, - # credit_debit_indicator:, - # effective_date:, - # idempotency_key:, - # notifications_of_change:, - # prenotification_return:, - # routing_number:, - # status:, - # type:, - # ** - # ) - # super - # end - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(id:, account_number:, addendum:, company_descriptive_date:, company_discretionary_data:, company_entry_description:, company_name:, created_at:, credit_debit_indicator:, effective_date:, idempotency_key:, notifications_of_change:, prenotification_return:, routing_number:, status:, type:) + # ACH Prenotifications are one way you can verify account and routing numbers by + # Automated Clearing House (ACH). + # + # @param id [String] + # @param account_number [String] + # @param addendum [String, nil] + # @param company_descriptive_date [String, nil] + # @param company_discretionary_data [String, nil] + # @param company_entry_description [String, nil] + # @param company_name [String, nil] + # @param created_at [Time] + # @param credit_debit_indicator [Symbol, Increase::Models::ACHPrenotification::CreditDebitIndicator, nil] + # @param effective_date [Time, nil] + # @param idempotency_key [String, nil] + # @param notifications_of_change [Array] + # @param prenotification_return [Increase::Models::ACHPrenotification::PrenotificationReturn, nil] + # @param routing_number [String] + # @param status [Symbol, Increase::Models::ACHPrenotification::Status] + # @param type [Symbol, Increase::Models::ACHPrenotification::Type] # If the notification is for a future credit or debit. # @@ -167,11 +143,8 @@ module CreditDebitIndicator # The Prenotification is for an anticipated debit. DEBIT = :debit - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end class NotificationsOfChange < Increase::Internal::Type::BaseModel @@ -200,14 +173,10 @@ class NotificationsOfChange < Increase::Internal::Type::BaseModel # @return [Time] required :created_at, Time - # @!parse - # # @param change_code [Symbol, Increase::Models::ACHPrenotification::NotificationsOfChange::ChangeCode] - # # @param corrected_data [String] - # # @param created_at [Time] - # # - # def initialize(change_code:, corrected_data:, created_at:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(change_code:, corrected_data:, created_at:) + # @param change_code [Symbol, Increase::Models::ACHPrenotification::NotificationsOfChange::ChangeCode] + # @param corrected_data [String] + # @param created_at [Time] # The required type of change that is being signaled by the receiving financial # institution. @@ -279,11 +248,8 @@ module ChangeCode INCORRECT_TRANSACTION_CODE_BY_ORIGINATING_DEPOSITORY_FINANCIAL_INSTITUTION = :incorrect_transaction_code_by_originating_depository_financial_institution - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -303,15 +269,11 @@ class PrenotificationReturn < Increase::Internal::Type::BaseModel required :return_reason_code, enum: -> { Increase::Models::ACHPrenotification::PrenotificationReturn::ReturnReasonCode } - # @!parse - # # If your prenotification is returned, this will contain details of the return. - # # - # # @param created_at [Time] - # # @param return_reason_code [Symbol, Increase::Models::ACHPrenotification::PrenotificationReturn::ReturnReasonCode] - # # - # def initialize(created_at:, return_reason_code:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(created_at:, return_reason_code:) + # If your prenotification is returned, this will contain details of the return. + # + # @param created_at [Time] + # @param return_reason_code [Symbol, Increase::Models::ACHPrenotification::PrenotificationReturn::ReturnReasonCode] # Why the Prenotification was returned. # @@ -532,11 +494,8 @@ module ReturnReasonCode # Code R68. A rare return reason. The return was sent too late. UNTIMELY_RETURN = :untimely_return - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -558,11 +517,8 @@ module Status # The Prenotification is complete. SUBMITTED = :submitted - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # A constant representing the object's type. For this resource it will always be @@ -574,11 +530,8 @@ module Type ACH_PRENOTIFICATION = :ach_prenotification - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end diff --git a/lib/increase/models/ach_prenotification_create_params.rb b/lib/increase/models/ach_prenotification_create_params.rb index 74465b46e..e1b0f47a0 100644 --- a/lib/increase/models/ach_prenotification_create_params.rb +++ b/lib/increase/models/ach_prenotification_create_params.rb @@ -4,8 +4,7 @@ module Increase module Models # @see Increase::Resources::ACHPrenotifications#create class ACHPrenotificationCreateParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters # @!attribute account_id @@ -27,147 +26,85 @@ class ACHPrenotificationCreateParams < Increase::Internal::Type::BaseModel # @return [String] required :routing_number, String - # @!attribute [r] addendum + # @!attribute addendum # Additional information that will be sent to the recipient. # # @return [String, nil] optional :addendum, String - # @!parse - # # @return [String] - # attr_writer :addendum - - # @!attribute [r] company_descriptive_date + # @!attribute company_descriptive_date # The description of the date of the transfer. # # @return [String, nil] optional :company_descriptive_date, String - # @!parse - # # @return [String] - # attr_writer :company_descriptive_date - - # @!attribute [r] company_discretionary_data + # @!attribute company_discretionary_data # The data you choose to associate with the transfer. # # @return [String, nil] optional :company_discretionary_data, String - # @!parse - # # @return [String] - # attr_writer :company_discretionary_data - - # @!attribute [r] company_entry_description + # @!attribute company_entry_description # The description of the transfer you wish to be shown to the recipient. # # @return [String, nil] optional :company_entry_description, String - # @!parse - # # @return [String] - # attr_writer :company_entry_description - - # @!attribute [r] company_name + # @!attribute company_name # The name by which the recipient knows you. # # @return [String, nil] optional :company_name, String - # @!parse - # # @return [String] - # attr_writer :company_name - - # @!attribute [r] credit_debit_indicator + # @!attribute credit_debit_indicator # Whether the Prenotification is for a future debit or credit. # # @return [Symbol, Increase::Models::ACHPrenotificationCreateParams::CreditDebitIndicator, nil] optional :credit_debit_indicator, enum: -> { Increase::Models::ACHPrenotificationCreateParams::CreditDebitIndicator } - # @!parse - # # @return [Symbol, Increase::Models::ACHPrenotificationCreateParams::CreditDebitIndicator] - # attr_writer :credit_debit_indicator - - # @!attribute [r] effective_date + # @!attribute effective_date # The transfer effective date in # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. # # @return [Date, nil] optional :effective_date, Date - # @!parse - # # @return [Date] - # attr_writer :effective_date - - # @!attribute [r] individual_id + # @!attribute individual_id # Your identifier for the transfer recipient. # # @return [String, nil] optional :individual_id, String - # @!parse - # # @return [String] - # attr_writer :individual_id - - # @!attribute [r] individual_name + # @!attribute individual_name # The name of the transfer recipient. This value is information and not verified # by the recipient's bank. # # @return [String, nil] optional :individual_name, String - # @!parse - # # @return [String] - # attr_writer :individual_name - - # @!attribute [r] standard_entry_class_code + # @!attribute standard_entry_class_code # The Standard Entry Class (SEC) code to use for the ACH Prenotification. # # @return [Symbol, Increase::Models::ACHPrenotificationCreateParams::StandardEntryClassCode, nil] optional :standard_entry_class_code, enum: -> { Increase::Models::ACHPrenotificationCreateParams::StandardEntryClassCode } - # @!parse - # # @return [Symbol, Increase::Models::ACHPrenotificationCreateParams::StandardEntryClassCode] - # attr_writer :standard_entry_class_code - - # @!parse - # # @param account_id [String] - # # @param account_number [String] - # # @param routing_number [String] - # # @param addendum [String] - # # @param company_descriptive_date [String] - # # @param company_discretionary_data [String] - # # @param company_entry_description [String] - # # @param company_name [String] - # # @param credit_debit_indicator [Symbol, Increase::Models::ACHPrenotificationCreateParams::CreditDebitIndicator] - # # @param effective_date [Date] - # # @param individual_id [String] - # # @param individual_name [String] - # # @param standard_entry_class_code [Symbol, Increase::Models::ACHPrenotificationCreateParams::StandardEntryClassCode] - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize( - # account_id:, - # account_number:, - # routing_number:, - # addendum: nil, - # company_descriptive_date: nil, - # company_discretionary_data: nil, - # company_entry_description: nil, - # company_name: nil, - # credit_debit_indicator: nil, - # effective_date: nil, - # individual_id: nil, - # individual_name: nil, - # standard_entry_class_code: nil, - # request_options: {}, - # ** - # ) - # super - # end - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(account_id:, account_number:, routing_number:, addendum: nil, company_descriptive_date: nil, company_discretionary_data: nil, company_entry_description: nil, company_name: nil, credit_debit_indicator: nil, effective_date: nil, individual_id: nil, individual_name: nil, standard_entry_class_code: nil, request_options: {}) + # @param account_id [String] + # @param account_number [String] + # @param routing_number [String] + # @param addendum [String] + # @param company_descriptive_date [String] + # @param company_discretionary_data [String] + # @param company_entry_description [String] + # @param company_name [String] + # @param credit_debit_indicator [Symbol, Increase::Models::ACHPrenotificationCreateParams::CreditDebitIndicator] + # @param effective_date [Date] + # @param individual_id [String] + # @param individual_name [String] + # @param standard_entry_class_code [Symbol, Increase::Models::ACHPrenotificationCreateParams::StandardEntryClassCode] + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] # Whether the Prenotification is for a future debit or credit. module CreditDebitIndicator @@ -179,11 +116,8 @@ module CreditDebitIndicator # The Prenotification is for an anticipated debit. DEBIT = :debit - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # The Standard Entry Class (SEC) code to use for the ACH Prenotification. @@ -202,11 +136,8 @@ module StandardEntryClassCode # Internet Initiated (WEB). INTERNET_INITIATED = :internet_initiated - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end diff --git a/lib/increase/models/ach_prenotification_list_params.rb b/lib/increase/models/ach_prenotification_list_params.rb index 3abde12d9..4cb2a0ea2 100644 --- a/lib/increase/models/ach_prenotification_list_params.rb +++ b/lib/increase/models/ach_prenotification_list_params.rb @@ -4,30 +4,21 @@ module Increase module Models # @see Increase::Resources::ACHPrenotifications#list class ACHPrenotificationListParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters - # @!attribute [r] created_at + # @!attribute created_at # # @return [Increase::Models::ACHPrenotificationListParams::CreatedAt, nil] optional :created_at, -> { Increase::Models::ACHPrenotificationListParams::CreatedAt } - # @!parse - # # @return [Increase::Models::ACHPrenotificationListParams::CreatedAt] - # attr_writer :created_at - - # @!attribute [r] cursor + # @!attribute cursor # Return the page of entries after this one. # # @return [String, nil] optional :cursor, String - # @!parse - # # @return [String] - # attr_writer :cursor - - # @!attribute [r] idempotency_key + # @!attribute idempotency_key # Filter records to the one with the specified `idempotency_key` you chose for # that object. This value is unique across Increase and is used to ensure that a # request is only processed once. Learn more about @@ -36,86 +27,54 @@ class ACHPrenotificationListParams < Increase::Internal::Type::BaseModel # @return [String, nil] optional :idempotency_key, String - # @!parse - # # @return [String] - # attr_writer :idempotency_key - - # @!attribute [r] limit + # @!attribute limit # Limit the size of the list that is returned. The default (and maximum) is 100 # objects. # # @return [Integer, nil] optional :limit, Integer - # @!parse - # # @return [Integer] - # attr_writer :limit - - # @!parse - # # @param created_at [Increase::Models::ACHPrenotificationListParams::CreatedAt] - # # @param cursor [String] - # # @param idempotency_key [String] - # # @param limit [Integer] - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(created_at: nil, cursor: nil, idempotency_key: nil, limit: nil, request_options: {}, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(created_at: nil, cursor: nil, idempotency_key: nil, limit: nil, request_options: {}) + # @param created_at [Increase::Models::ACHPrenotificationListParams::CreatedAt] + # @param cursor [String] + # @param idempotency_key [String] + # @param limit [Integer] + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] class CreatedAt < Increase::Internal::Type::BaseModel - # @!attribute [r] after + # @!attribute after # Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) # timestamp. # # @return [Time, nil] optional :after, Time - # @!parse - # # @return [Time] - # attr_writer :after - - # @!attribute [r] before + # @!attribute before # Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) # timestamp. # # @return [Time, nil] optional :before, Time - # @!parse - # # @return [Time] - # attr_writer :before - - # @!attribute [r] on_or_after + # @!attribute on_or_after # Return results on or after this # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. # # @return [Time, nil] optional :on_or_after, Time - # @!parse - # # @return [Time] - # attr_writer :on_or_after - - # @!attribute [r] on_or_before + # @!attribute on_or_before # Return results on or before this # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. # # @return [Time, nil] optional :on_or_before, Time - # @!parse - # # @return [Time] - # attr_writer :on_or_before - - # @!parse - # # @param after [Time] - # # @param before [Time] - # # @param on_or_after [Time] - # # @param on_or_before [Time] - # # - # def initialize(after: nil, before: nil, on_or_after: nil, on_or_before: nil, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(after: nil, before: nil, on_or_after: nil, on_or_before: nil) + # @param after [Time] + # @param before [Time] + # @param on_or_after [Time] + # @param on_or_before [Time] end end end diff --git a/lib/increase/models/ach_prenotification_retrieve_params.rb b/lib/increase/models/ach_prenotification_retrieve_params.rb index 4881a485b..55083a4f6 100644 --- a/lib/increase/models/ach_prenotification_retrieve_params.rb +++ b/lib/increase/models/ach_prenotification_retrieve_params.rb @@ -4,16 +4,11 @@ module Increase module Models # @see Increase::Resources::ACHPrenotifications#retrieve class ACHPrenotificationRetrieveParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters - # @!parse - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(request_options: {}, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(request_options: {}) + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/increase/models/ach_transfer.rb b/lib/increase/models/ach_transfer.rb index 1ea03cc3d..8f14b1b27 100644 --- a/lib/increase/models/ach_transfer.rb +++ b/lib/increase/models/ach_transfer.rb @@ -247,90 +247,46 @@ class ACHTransfer < Increase::Internal::Type::BaseModel # @return [Symbol, Increase::Models::ACHTransfer::Type] required :type, enum: -> { Increase::Models::ACHTransfer::Type } - # @!parse - # # ACH transfers move funds between your Increase account and any other account - # # accessible by the Automated Clearing House (ACH). - # # - # # @param id [String] - # # @param account_id [String] - # # @param account_number [String] - # # @param acknowledgement [Increase::Models::ACHTransfer::Acknowledgement, nil] - # # @param addenda [Increase::Models::ACHTransfer::Addenda, nil] - # # @param amount [Integer] - # # @param approval [Increase::Models::ACHTransfer::Approval, nil] - # # @param cancellation [Increase::Models::ACHTransfer::Cancellation, nil] - # # @param company_descriptive_date [String, nil] - # # @param company_discretionary_data [String, nil] - # # @param company_entry_description [String, nil] - # # @param company_id [String] - # # @param company_name [String, nil] - # # @param created_at [Time] - # # @param created_by [Increase::Models::ACHTransfer::CreatedBy, nil] - # # @param currency [Symbol, Increase::Models::ACHTransfer::Currency] - # # @param destination_account_holder [Symbol, Increase::Models::ACHTransfer::DestinationAccountHolder] - # # @param external_account_id [String, nil] - # # @param funding [Symbol, Increase::Models::ACHTransfer::Funding] - # # @param idempotency_key [String, nil] - # # @param inbound_funds_hold [Increase::Models::ACHTransfer::InboundFundsHold, nil] - # # @param individual_id [String, nil] - # # @param individual_name [String, nil] - # # @param network [Symbol, Increase::Models::ACHTransfer::Network] - # # @param notifications_of_change [Array] - # # @param pending_transaction_id [String, nil] - # # @param preferred_effective_date [Increase::Models::ACHTransfer::PreferredEffectiveDate] - # # @param return_ [Increase::Models::ACHTransfer::Return, nil] - # # @param routing_number [String] - # # @param settlement [Increase::Models::ACHTransfer::Settlement, nil] - # # @param standard_entry_class_code [Symbol, Increase::Models::ACHTransfer::StandardEntryClassCode] - # # @param statement_descriptor [String] - # # @param status [Symbol, Increase::Models::ACHTransfer::Status] - # # @param submission [Increase::Models::ACHTransfer::Submission, nil] - # # @param transaction_id [String, nil] - # # @param type [Symbol, Increase::Models::ACHTransfer::Type] - # # - # def initialize( - # id:, - # account_id:, - # account_number:, - # acknowledgement:, - # addenda:, - # amount:, - # approval:, - # cancellation:, - # company_descriptive_date:, - # company_discretionary_data:, - # company_entry_description:, - # company_id:, - # company_name:, - # created_at:, - # created_by:, - # currency:, - # destination_account_holder:, - # external_account_id:, - # funding:, - # idempotency_key:, - # inbound_funds_hold:, - # individual_id:, - # individual_name:, - # network:, - # notifications_of_change:, - # pending_transaction_id:, - # preferred_effective_date:, - # return_:, - # routing_number:, - # settlement:, - # standard_entry_class_code:, - # statement_descriptor:, - # status:, - # submission:, - # transaction_id:, - # type:, - # ** - # ) - # super - # end - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(id:, account_id:, account_number:, acknowledgement:, addenda:, amount:, approval:, cancellation:, company_descriptive_date:, company_discretionary_data:, company_entry_description:, company_id:, company_name:, created_at:, created_by:, currency:, destination_account_holder:, external_account_id:, funding:, idempotency_key:, inbound_funds_hold:, individual_id:, individual_name:, network:, notifications_of_change:, pending_transaction_id:, preferred_effective_date:, return_:, routing_number:, settlement:, standard_entry_class_code:, statement_descriptor:, status:, submission:, transaction_id:, type:) + # ACH transfers move funds between your Increase account and any other account + # accessible by the Automated Clearing House (ACH). + # + # @param id [String] + # @param account_id [String] + # @param account_number [String] + # @param acknowledgement [Increase::Models::ACHTransfer::Acknowledgement, nil] + # @param addenda [Increase::Models::ACHTransfer::Addenda, nil] + # @param amount [Integer] + # @param approval [Increase::Models::ACHTransfer::Approval, nil] + # @param cancellation [Increase::Models::ACHTransfer::Cancellation, nil] + # @param company_descriptive_date [String, nil] + # @param company_discretionary_data [String, nil] + # @param company_entry_description [String, nil] + # @param company_id [String] + # @param company_name [String, nil] + # @param created_at [Time] + # @param created_by [Increase::Models::ACHTransfer::CreatedBy, nil] + # @param currency [Symbol, Increase::Models::ACHTransfer::Currency] + # @param destination_account_holder [Symbol, Increase::Models::ACHTransfer::DestinationAccountHolder] + # @param external_account_id [String, nil] + # @param funding [Symbol, Increase::Models::ACHTransfer::Funding] + # @param idempotency_key [String, nil] + # @param inbound_funds_hold [Increase::Models::ACHTransfer::InboundFundsHold, nil] + # @param individual_id [String, nil] + # @param individual_name [String, nil] + # @param network [Symbol, Increase::Models::ACHTransfer::Network] + # @param notifications_of_change [Array] + # @param pending_transaction_id [String, nil] + # @param preferred_effective_date [Increase::Models::ACHTransfer::PreferredEffectiveDate] + # @param return_ [Increase::Models::ACHTransfer::Return, nil] + # @param routing_number [String] + # @param settlement [Increase::Models::ACHTransfer::Settlement, nil] + # @param standard_entry_class_code [Symbol, Increase::Models::ACHTransfer::StandardEntryClassCode] + # @param statement_descriptor [String] + # @param status [Symbol, Increase::Models::ACHTransfer::Status] + # @param submission [Increase::Models::ACHTransfer::Submission, nil] + # @param transaction_id [String, nil] + # @param type [Symbol, Increase::Models::ACHTransfer::Type] # @see Increase::Models::ACHTransfer#acknowledgement class Acknowledgement < Increase::Internal::Type::BaseModel @@ -341,16 +297,12 @@ class Acknowledgement < Increase::Internal::Type::BaseModel # @return [String] required :acknowledged_at, String - # @!parse - # # After the transfer is acknowledged by FedACH, this will contain supplemental - # # details. The Federal Reserve sends an acknowledgement message for each file that - # # Increase submits. - # # - # # @param acknowledged_at [String] - # # - # def initialize(acknowledged_at:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(acknowledged_at:) + # After the transfer is acknowledged by FedACH, this will contain supplemental + # details. The Federal Reserve sends an acknowledgement message for each file that + # Increase submits. + # + # @param acknowledged_at [String] end # @see Increase::Models::ACHTransfer#addenda @@ -377,16 +329,12 @@ class Addenda < Increase::Internal::Type::BaseModel -> { Increase::Models::ACHTransfer::Addenda::PaymentOrderRemittanceAdvice }, nil?: true - # @!parse - # # Additional information that will be sent to the recipient. - # # - # # @param category [Symbol, Increase::Models::ACHTransfer::Addenda::Category] - # # @param freeform [Increase::Models::ACHTransfer::Addenda::Freeform, nil] - # # @param payment_order_remittance_advice [Increase::Models::ACHTransfer::Addenda::PaymentOrderRemittanceAdvice, nil] - # # - # def initialize(category:, freeform:, payment_order_remittance_advice:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(category:, freeform:, payment_order_remittance_advice:) + # Additional information that will be sent to the recipient. + # + # @param category [Symbol, Increase::Models::ACHTransfer::Addenda::Category] + # @param freeform [Increase::Models::ACHTransfer::Addenda::Freeform, nil] + # @param payment_order_remittance_advice [Increase::Models::ACHTransfer::Addenda::PaymentOrderRemittanceAdvice, nil] # The type of the resource. We may add additional possible values for this enum # over time; your application should be able to handle such additions gracefully. @@ -404,11 +352,8 @@ module Category # Unknown addenda type. OTHER = :other - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Increase::Models::ACHTransfer::Addenda#freeform @@ -420,14 +365,10 @@ class Freeform < Increase::Internal::Type::BaseModel required :entries, -> { Increase::Internal::Type::ArrayOf[Increase::Models::ACHTransfer::Addenda::Freeform::Entry] } - # @!parse - # # Unstructured `payment_related_information` passed through with the transfer. - # # - # # @param entries [Array] - # # - # def initialize(entries:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(entries:) + # Unstructured `payment_related_information` passed through with the transfer. + # + # @param entries [Array] class Entry < Increase::Internal::Type::BaseModel # @!attribute payment_related_information @@ -436,12 +377,8 @@ class Entry < Increase::Internal::Type::BaseModel # @return [String] required :payment_related_information, String - # @!parse - # # @param payment_related_information [String] - # # - # def initialize(payment_related_information:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(payment_related_information:) + # @param payment_related_information [String] end end @@ -454,15 +391,11 @@ class PaymentOrderRemittanceAdvice < Increase::Internal::Type::BaseModel required :invoices, -> { Increase::Internal::Type::ArrayOf[Increase::Models::ACHTransfer::Addenda::PaymentOrderRemittanceAdvice::Invoice] } - # @!parse - # # Structured ASC X12 820 remittance advice records. Please reach out to - # # [support@increase.com](mailto:support@increase.com) for more information. - # # - # # @param invoices [Array] - # # - # def initialize(invoices:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(invoices:) + # Structured ASC X12 820 remittance advice records. Please reach out to + # [support@increase.com](mailto:support@increase.com) for more information. + # + # @param invoices [Array] class Invoice < Increase::Internal::Type::BaseModel # @!attribute invoice_number @@ -478,13 +411,9 @@ class Invoice < Increase::Internal::Type::BaseModel # @return [Integer] required :paid_amount, Integer - # @!parse - # # @param invoice_number [String] - # # @param paid_amount [Integer] - # # - # def initialize(invoice_number:, paid_amount:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(invoice_number:, paid_amount:) + # @param invoice_number [String] + # @param paid_amount [Integer] end end end @@ -505,16 +434,12 @@ class Approval < Increase::Internal::Type::BaseModel # @return [String, nil] required :approved_by, String, nil?: true - # @!parse - # # If your account requires approvals for transfers and the transfer was approved, - # # this will contain details of the approval. - # # - # # @param approved_at [Time] - # # @param approved_by [String, nil] - # # - # def initialize(approved_at:, approved_by:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(approved_at:, approved_by:) + # If your account requires approvals for transfers and the transfer was approved, + # this will contain details of the approval. + # + # @param approved_at [Time] + # @param approved_by [String, nil] end # @see Increase::Models::ACHTransfer#cancellation @@ -533,16 +458,12 @@ class Cancellation < Increase::Internal::Type::BaseModel # @return [String, nil] required :canceled_by, String, nil?: true - # @!parse - # # If your account requires approvals for transfers and the transfer was not - # # approved, this will contain details of the cancellation. - # # - # # @param canceled_at [Time] - # # @param canceled_by [String, nil] - # # - # def initialize(canceled_at:, canceled_by:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(canceled_at:, canceled_by:) + # If your account requires approvals for transfers and the transfer was not + # approved, this will contain details of the cancellation. + # + # @param canceled_at [Time] + # @param canceled_by [String, nil] end # @see Increase::Models::ACHTransfer#created_by @@ -571,17 +492,13 @@ class CreatedBy < Increase::Internal::Type::BaseModel # @return [Increase::Models::ACHTransfer::CreatedBy::User, nil] required :user, -> { Increase::Models::ACHTransfer::CreatedBy::User }, nil?: true - # @!parse - # # What object created the transfer, either via the API or the dashboard. - # # - # # @param api_key [Increase::Models::ACHTransfer::CreatedBy::APIKey, nil] - # # @param category [Symbol, Increase::Models::ACHTransfer::CreatedBy::Category] - # # @param oauth_application [Increase::Models::ACHTransfer::CreatedBy::OAuthApplication, nil] - # # @param user [Increase::Models::ACHTransfer::CreatedBy::User, nil] - # # - # def initialize(api_key:, category:, oauth_application:, user:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(api_key:, category:, oauth_application:, user:) + # What object created the transfer, either via the API or the dashboard. + # + # @param api_key [Increase::Models::ACHTransfer::CreatedBy::APIKey, nil] + # @param category [Symbol, Increase::Models::ACHTransfer::CreatedBy::Category] + # @param oauth_application [Increase::Models::ACHTransfer::CreatedBy::OAuthApplication, nil] + # @param user [Increase::Models::ACHTransfer::CreatedBy::User, nil] # @see Increase::Models::ACHTransfer::CreatedBy#api_key class APIKey < Increase::Internal::Type::BaseModel @@ -591,14 +508,10 @@ class APIKey < Increase::Internal::Type::BaseModel # @return [String, nil] required :description, String, nil?: true - # @!parse - # # If present, details about the API key that created the transfer. - # # - # # @param description [String, nil] - # # - # def initialize(description:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(description:) + # If present, details about the API key that created the transfer. + # + # @param description [String, nil] end # The type of object that created this transfer. @@ -616,11 +529,8 @@ module Category # A User in the Increase dashboard. Details will be under the `user` object. USER = :user - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Increase::Models::ACHTransfer::CreatedBy#oauth_application @@ -631,14 +541,10 @@ class OAuthApplication < Increase::Internal::Type::BaseModel # @return [String] required :name, String - # @!parse - # # If present, details about the OAuth Application that created the transfer. - # # - # # @param name [String] - # # - # def initialize(name:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(name:) + # If present, details about the OAuth Application that created the transfer. + # + # @param name [String] end # @see Increase::Models::ACHTransfer::CreatedBy#user @@ -649,14 +555,10 @@ class User < Increase::Internal::Type::BaseModel # @return [String] required :email, String - # @!parse - # # If present, details about the User that created the transfer. - # # - # # @param email [String] - # # - # def initialize(email:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(email:) + # If present, details about the User that created the transfer. + # + # @param email [String] end end @@ -685,11 +587,8 @@ module Currency # US Dollar (USD) USD = :USD - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # The type of entity that owns the account to which the ACH Transfer is being @@ -708,11 +607,8 @@ module DestinationAccountHolder # It's unknown what kind of entity owns the External Account. UNKNOWN = :unknown - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # The type of the account to which the transfer will be sent. @@ -727,11 +623,8 @@ module Funding # A savings account. SAVINGS = :savings - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Increase::Models::ACHTransfer#inbound_funds_hold @@ -801,38 +694,20 @@ class InboundFundsHold < Increase::Internal::Type::BaseModel # @return [Symbol, Increase::Models::ACHTransfer::InboundFundsHold::Type] required :type, enum: -> { Increase::Models::ACHTransfer::InboundFundsHold::Type } - # @!parse - # # Increase will sometimes hold the funds for ACH debit transfers. If funds are - # # held, this sub-object will contain details of the hold. - # # - # # @param id [String] - # # @param amount [Integer] - # # @param automatically_releases_at [Time] - # # @param created_at [Time] - # # @param currency [Symbol, Increase::Models::ACHTransfer::InboundFundsHold::Currency] - # # @param held_transaction_id [String, nil] - # # @param pending_transaction_id [String, nil] - # # @param released_at [Time, nil] - # # @param status [Symbol, Increase::Models::ACHTransfer::InboundFundsHold::Status] - # # @param type [Symbol, Increase::Models::ACHTransfer::InboundFundsHold::Type] - # # - # def initialize( - # id:, - # amount:, - # automatically_releases_at:, - # created_at:, - # currency:, - # held_transaction_id:, - # pending_transaction_id:, - # released_at:, - # status:, - # type:, - # ** - # ) - # super - # end - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(id:, amount:, automatically_releases_at:, created_at:, currency:, held_transaction_id:, pending_transaction_id:, released_at:, status:, type:) + # Increase will sometimes hold the funds for ACH debit transfers. If funds are + # held, this sub-object will contain details of the hold. + # + # @param id [String] + # @param amount [Integer] + # @param automatically_releases_at [Time] + # @param created_at [Time] + # @param currency [Symbol, Increase::Models::ACHTransfer::InboundFundsHold::Currency] + # @param held_transaction_id [String, nil] + # @param pending_transaction_id [String, nil] + # @param released_at [Time, nil] + # @param status [Symbol, Increase::Models::ACHTransfer::InboundFundsHold::Status] + # @param type [Symbol, Increase::Models::ACHTransfer::InboundFundsHold::Type] # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the hold's # currency. @@ -859,11 +734,8 @@ module Currency # US Dollar (USD) USD = :USD - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # The status of the hold. @@ -878,11 +750,8 @@ module Status # Funds have been released. COMPLETE = :complete - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # A constant representing the object's type. For this resource it will always be @@ -894,11 +763,8 @@ module Type INBOUND_FUNDS_HOLD = :inbound_funds_hold - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -910,11 +776,8 @@ module Network ACH = :ach - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end class NotificationsOfChange < Increase::Internal::Type::BaseModel @@ -942,14 +805,10 @@ class NotificationsOfChange < Increase::Internal::Type::BaseModel # @return [Time] required :created_at, Time - # @!parse - # # @param change_code [Symbol, Increase::Models::ACHTransfer::NotificationsOfChange::ChangeCode] - # # @param corrected_data [String] - # # @param created_at [Time] - # # - # def initialize(change_code:, corrected_data:, created_at:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(change_code:, corrected_data:, created_at:) + # @param change_code [Symbol, Increase::Models::ACHTransfer::NotificationsOfChange::ChangeCode] + # @param corrected_data [String] + # @param created_at [Time] # The required type of change that is being signaled by the receiving financial # institution. @@ -1021,11 +880,8 @@ module ChangeCode INCORRECT_TRANSACTION_CODE_BY_ORIGINATING_DEPOSITORY_FINANCIAL_INSTITUTION = :incorrect_transaction_code_by_originating_depository_financial_institution - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -1046,18 +902,14 @@ class PreferredEffectiveDate < Increase::Internal::Type::BaseModel enum: -> { Increase::Models::ACHTransfer::PreferredEffectiveDate::SettlementSchedule }, nil?: true - # @!parse - # # Configuration for how the effective date of the transfer will be set. This - # # determines same-day vs future-dated settlement timing. If not set, defaults to a - # # `settlement_schedule` of `same_day`. If set, exactly one of the child attributes - # # must be set. - # # - # # @param date [Date, nil] - # # @param settlement_schedule [Symbol, Increase::Models::ACHTransfer::PreferredEffectiveDate::SettlementSchedule, nil] - # # - # def initialize(date:, settlement_schedule:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(date:, settlement_schedule:) + # Configuration for how the effective date of the transfer will be set. This + # determines same-day vs future-dated settlement timing. If not set, defaults to a + # `settlement_schedule` of `same_day`. If set, exactly one of the child attributes + # must be set. + # + # @param date [Date, nil] + # @param settlement_schedule [Symbol, Increase::Models::ACHTransfer::PreferredEffectiveDate::SettlementSchedule, nil] # A schedule by which Increase will choose an effective date for the transfer. # @@ -1074,11 +926,8 @@ module SettlementSchedule # The chosen effective date will be the business day following the ACH processing date on which the transfer is submitted. The transfer will be settled on that future day. FUTURE_DATED = :future_dated - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -1125,29 +974,15 @@ class Return < Increase::Internal::Type::BaseModel # @return [String] required :transfer_id, String - # @!parse - # # If your transfer is returned, this will contain details of the return. - # # - # # @param created_at [Time] - # # @param raw_return_reason_code [String] - # # @param return_reason_code [Symbol, Increase::Models::ACHTransfer::Return::ReturnReasonCode] - # # @param trace_number [String] - # # @param transaction_id [String] - # # @param transfer_id [String] - # # - # def initialize( - # created_at:, - # raw_return_reason_code:, - # return_reason_code:, - # trace_number:, - # transaction_id:, - # transfer_id:, - # ** - # ) - # super - # end - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(created_at:, raw_return_reason_code:, return_reason_code:, trace_number:, transaction_id:, transfer_id:) + # If your transfer is returned, this will contain details of the return. + # + # @param created_at [Time] + # @param raw_return_reason_code [String] + # @param return_reason_code [Symbol, Increase::Models::ACHTransfer::Return::ReturnReasonCode] + # @param trace_number [String] + # @param transaction_id [String] + # @param transfer_id [String] # Why the ACH Transfer was returned. This reason code is sent by the receiving # bank back to Increase. @@ -1369,11 +1204,8 @@ module ReturnReasonCode # Code R68. A rare return reason. The return was sent too late. UNTIMELY_RETURN = :untimely_return - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -1386,15 +1218,11 @@ class Settlement < Increase::Internal::Type::BaseModel # @return [Time] required :settled_at, Time - # @!parse - # # A subhash containing information about when and how the transfer settled at the - # # Federal Reserve. - # # - # # @param settled_at [Time] - # # - # def initialize(settled_at:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(settled_at:) + # A subhash containing information about when and how the transfer settled at the + # Federal Reserve. + # + # @param settled_at [Time] end # The Standard Entry Class (SEC) code to use for the transfer. @@ -1415,11 +1243,8 @@ module StandardEntryClassCode # Internet Initiated (WEB). INTERNET_INITIATED = :internet_initiated - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # The lifecycle status of the transfer. @@ -1455,11 +1280,8 @@ module Status # The transfer has been returned. RETURNED = :returned - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Increase::Models::ACHTransfer#submission @@ -1507,31 +1329,18 @@ class Submission < Increase::Internal::Type::BaseModel # @return [String] required :trace_number, String - # @!parse - # # After the transfer is submitted to FedACH, this will contain supplemental - # # details. Increase batches transfers and submits a file to the Federal Reserve - # # roughly every 30 minutes. The Federal Reserve processes ACH transfers during - # # weekdays according to their - # # [posted schedule](https://www.frbservices.org/resources/resource-centers/same-day-ach/fedach-processing-schedule.html). - # # - # # @param effective_date [Date] - # # @param expected_funds_settlement_at [Time] - # # @param expected_settlement_schedule [Symbol, Increase::Models::ACHTransfer::Submission::ExpectedSettlementSchedule] - # # @param submitted_at [Time] - # # @param trace_number [String] - # # - # def initialize( - # effective_date:, - # expected_funds_settlement_at:, - # expected_settlement_schedule:, - # submitted_at:, - # trace_number:, - # ** - # ) - # super - # end - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(effective_date:, expected_funds_settlement_at:, expected_settlement_schedule:, submitted_at:, trace_number:) + # After the transfer is submitted to FedACH, this will contain supplemental + # details. Increase batches transfers and submits a file to the Federal Reserve + # roughly every 30 minutes. The Federal Reserve processes ACH transfers during + # weekdays according to their + # [posted schedule](https://www.frbservices.org/resources/resource-centers/same-day-ach/fedach-processing-schedule.html). + # + # @param effective_date [Date] + # @param expected_funds_settlement_at [Time] + # @param expected_settlement_schedule [Symbol, Increase::Models::ACHTransfer::Submission::ExpectedSettlementSchedule] + # @param submitted_at [Time] + # @param trace_number [String] # The settlement schedule the transfer is expected to follow. This expectation # takes into account the `effective_date`, `submitted_at`, and the amount of the @@ -1547,11 +1356,8 @@ module ExpectedSettlementSchedule # The transfer is expected to settle on a future date. FUTURE_DATED = :future_dated - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -1564,11 +1370,8 @@ module Type ACH_TRANSFER = :ach_transfer - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end diff --git a/lib/increase/models/ach_transfer_approve_params.rb b/lib/increase/models/ach_transfer_approve_params.rb index 3c4e814f2..17cb16697 100644 --- a/lib/increase/models/ach_transfer_approve_params.rb +++ b/lib/increase/models/ach_transfer_approve_params.rb @@ -4,16 +4,11 @@ module Increase module Models # @see Increase::Resources::ACHTransfers#approve class ACHTransferApproveParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters - # @!parse - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(request_options: {}, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(request_options: {}) + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/increase/models/ach_transfer_cancel_params.rb b/lib/increase/models/ach_transfer_cancel_params.rb index b26812d61..b19728a9e 100644 --- a/lib/increase/models/ach_transfer_cancel_params.rb +++ b/lib/increase/models/ach_transfer_cancel_params.rb @@ -4,16 +4,11 @@ module Increase module Models # @see Increase::Resources::ACHTransfers#cancel class ACHTransferCancelParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters - # @!parse - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(request_options: {}, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(request_options: {}) + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/increase/models/ach_transfer_create_params.rb b/lib/increase/models/ach_transfer_create_params.rb index 6d19b0b59..6a7517b16 100644 --- a/lib/increase/models/ach_transfer_create_params.rb +++ b/lib/increase/models/ach_transfer_create_params.rb @@ -4,8 +4,7 @@ module Increase module Models # @see Increase::Resources::ACHTransfers#create class ACHTransferCreateParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters # @!attribute account_id @@ -33,72 +32,48 @@ class ACHTransferCreateParams < Increase::Internal::Type::BaseModel # @return [String] required :statement_descriptor, String - # @!attribute [r] account_number + # @!attribute account_number # The account number for the destination account. # # @return [String, nil] optional :account_number, String - # @!parse - # # @return [String] - # attr_writer :account_number - - # @!attribute [r] addenda + # @!attribute addenda # Additional information that will be sent to the recipient. This is included in # the transfer data sent to the receiving bank. # # @return [Increase::Models::ACHTransferCreateParams::Addenda, nil] optional :addenda, -> { Increase::Models::ACHTransferCreateParams::Addenda } - # @!parse - # # @return [Increase::Models::ACHTransferCreateParams::Addenda] - # attr_writer :addenda - - # @!attribute [r] company_descriptive_date + # @!attribute company_descriptive_date # The description of the date of the transfer, usually in the format `YYMMDD`. # This is included in the transfer data sent to the receiving bank. # # @return [String, nil] optional :company_descriptive_date, String - # @!parse - # # @return [String] - # attr_writer :company_descriptive_date - - # @!attribute [r] company_discretionary_data + # @!attribute company_discretionary_data # The data you choose to associate with the transfer. This is included in the # transfer data sent to the receiving bank. # # @return [String, nil] optional :company_discretionary_data, String - # @!parse - # # @return [String] - # attr_writer :company_discretionary_data - - # @!attribute [r] company_entry_description + # @!attribute company_entry_description # A description of the transfer. This is included in the transfer data sent to the # receiving bank. # # @return [String, nil] optional :company_entry_description, String - # @!parse - # # @return [String] - # attr_writer :company_entry_description - - # @!attribute [r] company_name + # @!attribute company_name # The name by which the recipient knows you. This is included in the transfer data # sent to the receiving bank. # # @return [String, nil] optional :company_name, String - # @!parse - # # @return [String] - # attr_writer :company_name - - # @!attribute [r] destination_account_holder + # @!attribute destination_account_holder # The type of entity that owns the account to which the ACH Transfer is being # sent. # @@ -106,53 +81,33 @@ class ACHTransferCreateParams < Increase::Internal::Type::BaseModel optional :destination_account_holder, enum: -> { Increase::Models::ACHTransferCreateParams::DestinationAccountHolder } - # @!parse - # # @return [Symbol, Increase::Models::ACHTransferCreateParams::DestinationAccountHolder] - # attr_writer :destination_account_holder - - # @!attribute [r] external_account_id + # @!attribute external_account_id # The ID of an External Account to initiate a transfer to. If this parameter is # provided, `account_number`, `routing_number`, and `funding` must be absent. # # @return [String, nil] optional :external_account_id, String - # @!parse - # # @return [String] - # attr_writer :external_account_id - - # @!attribute [r] funding + # @!attribute funding # The type of the account to which the transfer will be sent. # # @return [Symbol, Increase::Models::ACHTransferCreateParams::Funding, nil] optional :funding, enum: -> { Increase::Models::ACHTransferCreateParams::Funding } - # @!parse - # # @return [Symbol, Increase::Models::ACHTransferCreateParams::Funding] - # attr_writer :funding - - # @!attribute [r] individual_id + # @!attribute individual_id # Your identifier for the transfer recipient. # # @return [String, nil] optional :individual_id, String - # @!parse - # # @return [String] - # attr_writer :individual_id - - # @!attribute [r] individual_name + # @!attribute individual_name # The name of the transfer recipient. This value is informational and not verified # by the recipient's bank. # # @return [String, nil] optional :individual_name, String - # @!parse - # # @return [String] - # attr_writer :individual_name - - # @!attribute [r] preferred_effective_date + # @!attribute preferred_effective_date # Configuration for how the effective date of the transfer will be set. This # determines same-day vs future-dated settlement timing. If not set, defaults to a # `settlement_schedule` of `same_day`. If set, exactly one of the child attributes @@ -162,101 +117,53 @@ class ACHTransferCreateParams < Increase::Internal::Type::BaseModel optional :preferred_effective_date, -> { Increase::Models::ACHTransferCreateParams::PreferredEffectiveDate } - # @!parse - # # @return [Increase::Models::ACHTransferCreateParams::PreferredEffectiveDate] - # attr_writer :preferred_effective_date - - # @!attribute [r] require_approval + # @!attribute require_approval # Whether the transfer requires explicit approval via the dashboard or API. # # @return [Boolean, nil] optional :require_approval, Increase::Internal::Type::Boolean - # @!parse - # # @return [Boolean] - # attr_writer :require_approval - - # @!attribute [r] routing_number + # @!attribute routing_number # The American Bankers' Association (ABA) Routing Transit Number (RTN) for the # destination account. # # @return [String, nil] optional :routing_number, String - # @!parse - # # @return [String] - # attr_writer :routing_number - - # @!attribute [r] standard_entry_class_code + # @!attribute standard_entry_class_code # The Standard Entry Class (SEC) code to use for the transfer. # # @return [Symbol, Increase::Models::ACHTransferCreateParams::StandardEntryClassCode, nil] optional :standard_entry_class_code, enum: -> { Increase::Models::ACHTransferCreateParams::StandardEntryClassCode } - # @!parse - # # @return [Symbol, Increase::Models::ACHTransferCreateParams::StandardEntryClassCode] - # attr_writer :standard_entry_class_code - - # @!attribute [r] transaction_timing + # @!attribute transaction_timing # The timing of the transaction. # # @return [Symbol, Increase::Models::ACHTransferCreateParams::TransactionTiming, nil] optional :transaction_timing, enum: -> { Increase::Models::ACHTransferCreateParams::TransactionTiming } - # @!parse - # # @return [Symbol, Increase::Models::ACHTransferCreateParams::TransactionTiming] - # attr_writer :transaction_timing - - # @!parse - # # @param account_id [String] - # # @param amount [Integer] - # # @param statement_descriptor [String] - # # @param account_number [String] - # # @param addenda [Increase::Models::ACHTransferCreateParams::Addenda] - # # @param company_descriptive_date [String] - # # @param company_discretionary_data [String] - # # @param company_entry_description [String] - # # @param company_name [String] - # # @param destination_account_holder [Symbol, Increase::Models::ACHTransferCreateParams::DestinationAccountHolder] - # # @param external_account_id [String] - # # @param funding [Symbol, Increase::Models::ACHTransferCreateParams::Funding] - # # @param individual_id [String] - # # @param individual_name [String] - # # @param preferred_effective_date [Increase::Models::ACHTransferCreateParams::PreferredEffectiveDate] - # # @param require_approval [Boolean] - # # @param routing_number [String] - # # @param standard_entry_class_code [Symbol, Increase::Models::ACHTransferCreateParams::StandardEntryClassCode] - # # @param transaction_timing [Symbol, Increase::Models::ACHTransferCreateParams::TransactionTiming] - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize( - # account_id:, - # amount:, - # statement_descriptor:, - # account_number: nil, - # addenda: nil, - # company_descriptive_date: nil, - # company_discretionary_data: nil, - # company_entry_description: nil, - # company_name: nil, - # destination_account_holder: nil, - # external_account_id: nil, - # funding: nil, - # individual_id: nil, - # individual_name: nil, - # preferred_effective_date: nil, - # require_approval: nil, - # routing_number: nil, - # standard_entry_class_code: nil, - # transaction_timing: nil, - # request_options: {}, - # ** - # ) - # super - # end - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(account_id:, amount:, statement_descriptor:, account_number: nil, addenda: nil, company_descriptive_date: nil, company_discretionary_data: nil, company_entry_description: nil, company_name: nil, destination_account_holder: nil, external_account_id: nil, funding: nil, individual_id: nil, individual_name: nil, preferred_effective_date: nil, require_approval: nil, routing_number: nil, standard_entry_class_code: nil, transaction_timing: nil, request_options: {}) + # @param account_id [String] + # @param amount [Integer] + # @param statement_descriptor [String] + # @param account_number [String] + # @param addenda [Increase::Models::ACHTransferCreateParams::Addenda] + # @param company_descriptive_date [String] + # @param company_discretionary_data [String] + # @param company_entry_description [String] + # @param company_name [String] + # @param destination_account_holder [Symbol, Increase::Models::ACHTransferCreateParams::DestinationAccountHolder] + # @param external_account_id [String] + # @param funding [Symbol, Increase::Models::ACHTransferCreateParams::Funding] + # @param individual_id [String] + # @param individual_name [String] + # @param preferred_effective_date [Increase::Models::ACHTransferCreateParams::PreferredEffectiveDate] + # @param require_approval [Boolean] + # @param routing_number [String] + # @param standard_entry_class_code [Symbol, Increase::Models::ACHTransferCreateParams::StandardEntryClassCode] + # @param transaction_timing [Symbol, Increase::Models::ACHTransferCreateParams::TransactionTiming] + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] class Addenda < Increase::Internal::Type::BaseModel # @!attribute category @@ -265,17 +172,13 @@ class Addenda < Increase::Internal::Type::BaseModel # @return [Symbol, Increase::Models::ACHTransferCreateParams::Addenda::Category] required :category, enum: -> { Increase::Models::ACHTransferCreateParams::Addenda::Category } - # @!attribute [r] freeform + # @!attribute freeform # Unstructured `payment_related_information` passed through with the transfer. # # @return [Increase::Models::ACHTransferCreateParams::Addenda::Freeform, nil] optional :freeform, -> { Increase::Models::ACHTransferCreateParams::Addenda::Freeform } - # @!parse - # # @return [Increase::Models::ACHTransferCreateParams::Addenda::Freeform] - # attr_writer :freeform - - # @!attribute [r] payment_order_remittance_advice + # @!attribute payment_order_remittance_advice # Structured ASC X12 820 remittance advice records. Please reach out to # [support@increase.com](mailto:support@increase.com) for more information. # @@ -283,21 +186,13 @@ class Addenda < Increase::Internal::Type::BaseModel optional :payment_order_remittance_advice, -> { Increase::Models::ACHTransferCreateParams::Addenda::PaymentOrderRemittanceAdvice } - # @!parse - # # @return [Increase::Models::ACHTransferCreateParams::Addenda::PaymentOrderRemittanceAdvice] - # attr_writer :payment_order_remittance_advice - - # @!parse - # # Additional information that will be sent to the recipient. This is included in - # # the transfer data sent to the receiving bank. - # # - # # @param category [Symbol, Increase::Models::ACHTransferCreateParams::Addenda::Category] - # # @param freeform [Increase::Models::ACHTransferCreateParams::Addenda::Freeform] - # # @param payment_order_remittance_advice [Increase::Models::ACHTransferCreateParams::Addenda::PaymentOrderRemittanceAdvice] - # # - # def initialize(category:, freeform: nil, payment_order_remittance_advice: nil, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(category:, freeform: nil, payment_order_remittance_advice: nil) + # Additional information that will be sent to the recipient. This is included in + # the transfer data sent to the receiving bank. + # + # @param category [Symbol, Increase::Models::ACHTransferCreateParams::Addenda::Category] + # @param freeform [Increase::Models::ACHTransferCreateParams::Addenda::Freeform] + # @param payment_order_remittance_advice [Increase::Models::ACHTransferCreateParams::Addenda::PaymentOrderRemittanceAdvice] # The type of addenda to pass with the transfer. # @@ -311,11 +206,8 @@ module Category # Structured ASC X12 820 remittance advice records. Please reach out to [support@increase.com](mailto:support@increase.com) for more information. PAYMENT_ORDER_REMITTANCE_ADVICE = :payment_order_remittance_advice - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Increase::Models::ACHTransferCreateParams::Addenda#freeform @@ -329,14 +221,10 @@ class Freeform < Increase::Internal::Type::BaseModel required :entries, -> { Increase::Internal::Type::ArrayOf[Increase::Models::ACHTransferCreateParams::Addenda::Freeform::Entry] } - # @!parse - # # Unstructured `payment_related_information` passed through with the transfer. - # # - # # @param entries [Array] - # # - # def initialize(entries:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(entries:) + # Unstructured `payment_related_information` passed through with the transfer. + # + # @param entries [Array] class Entry < Increase::Internal::Type::BaseModel # @!attribute payment_related_information @@ -345,12 +233,8 @@ class Entry < Increase::Internal::Type::BaseModel # @return [String] required :payment_related_information, String - # @!parse - # # @param payment_related_information [String] - # # - # def initialize(payment_related_information:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(payment_related_information:) + # @param payment_related_information [String] end end @@ -363,15 +247,11 @@ class PaymentOrderRemittanceAdvice < Increase::Internal::Type::BaseModel required :invoices, -> { Increase::Internal::Type::ArrayOf[Increase::Models::ACHTransferCreateParams::Addenda::PaymentOrderRemittanceAdvice::Invoice] } - # @!parse - # # Structured ASC X12 820 remittance advice records. Please reach out to - # # [support@increase.com](mailto:support@increase.com) for more information. - # # - # # @param invoices [Array] - # # - # def initialize(invoices:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(invoices:) + # Structured ASC X12 820 remittance advice records. Please reach out to + # [support@increase.com](mailto:support@increase.com) for more information. + # + # @param invoices [Array] class Invoice < Increase::Internal::Type::BaseModel # @!attribute invoice_number @@ -387,13 +267,9 @@ class Invoice < Increase::Internal::Type::BaseModel # @return [Integer] required :paid_amount, Integer - # @!parse - # # @param invoice_number [String] - # # @param paid_amount [Integer] - # # - # def initialize(invoice_number:, paid_amount:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(invoice_number:, paid_amount:) + # @param invoice_number [String] + # @param paid_amount [Integer] end end end @@ -412,11 +288,8 @@ module DestinationAccountHolder # It's unknown what kind of entity owns the External Account. UNKNOWN = :unknown - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # The type of the account to which the transfer will be sent. @@ -429,48 +302,33 @@ module Funding # A savings account. SAVINGS = :savings - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end class PreferredEffectiveDate < Increase::Internal::Type::BaseModel - # @!attribute [r] date + # @!attribute date # A specific date in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format to # use as the effective date when submitting this transfer. # # @return [Date, nil] optional :date, Date - # @!parse - # # @return [Date] - # attr_writer :date - - # @!attribute [r] settlement_schedule + # @!attribute settlement_schedule # A schedule by which Increase will choose an effective date for the transfer. # # @return [Symbol, Increase::Models::ACHTransferCreateParams::PreferredEffectiveDate::SettlementSchedule, nil] optional :settlement_schedule, enum: -> { Increase::Models::ACHTransferCreateParams::PreferredEffectiveDate::SettlementSchedule } - # @!parse - # # @return [Symbol, Increase::Models::ACHTransferCreateParams::PreferredEffectiveDate::SettlementSchedule] - # attr_writer :settlement_schedule - - # @!parse - # # Configuration for how the effective date of the transfer will be set. This - # # determines same-day vs future-dated settlement timing. If not set, defaults to a - # # `settlement_schedule` of `same_day`. If set, exactly one of the child attributes - # # must be set. - # # - # # @param date [Date] - # # @param settlement_schedule [Symbol, Increase::Models::ACHTransferCreateParams::PreferredEffectiveDate::SettlementSchedule] - # # - # def initialize(date: nil, settlement_schedule: nil, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(date: nil, settlement_schedule: nil) + # Configuration for how the effective date of the transfer will be set. This + # determines same-day vs future-dated settlement timing. If not set, defaults to a + # `settlement_schedule` of `same_day`. If set, exactly one of the child attributes + # must be set. + # + # @param date [Date] + # @param settlement_schedule [Symbol, Increase::Models::ACHTransferCreateParams::PreferredEffectiveDate::SettlementSchedule] # A schedule by which Increase will choose an effective date for the transfer. # @@ -484,11 +342,8 @@ module SettlementSchedule # The chosen effective date will be the business day following the ACH processing date on which the transfer is submitted. The transfer will be settled on that future day. FUTURE_DATED = :future_dated - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -508,11 +363,8 @@ module StandardEntryClassCode # Internet Initiated (WEB). INTERNET_INITIATED = :internet_initiated - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # The timing of the transaction. @@ -525,11 +377,8 @@ module TransactionTiming # A Transaction will be created when the funds settle at the Federal Reserve. ASYNCHRONOUS = :asynchronous - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end diff --git a/lib/increase/models/ach_transfer_list_params.rb b/lib/increase/models/ach_transfer_list_params.rb index 3ac0fbfcb..f9015dfe4 100644 --- a/lib/increase/models/ach_transfer_list_params.rb +++ b/lib/increase/models/ach_transfer_list_params.rb @@ -4,50 +4,33 @@ module Increase module Models # @see Increase::Resources::ACHTransfers#list class ACHTransferListParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters - # @!attribute [r] account_id + # @!attribute account_id # Filter ACH Transfers to those that originated from the specified Account. # # @return [String, nil] optional :account_id, String - # @!parse - # # @return [String] - # attr_writer :account_id - - # @!attribute [r] created_at + # @!attribute created_at # # @return [Increase::Models::ACHTransferListParams::CreatedAt, nil] optional :created_at, -> { Increase::Models::ACHTransferListParams::CreatedAt } - # @!parse - # # @return [Increase::Models::ACHTransferListParams::CreatedAt] - # attr_writer :created_at - - # @!attribute [r] cursor + # @!attribute cursor # Return the page of entries after this one. # # @return [String, nil] optional :cursor, String - # @!parse - # # @return [String] - # attr_writer :cursor - - # @!attribute [r] external_account_id + # @!attribute external_account_id # Filter ACH Transfers to those made to the specified External Account. # # @return [String, nil] optional :external_account_id, String - # @!parse - # # @return [String] - # attr_writer :external_account_id - - # @!attribute [r] idempotency_key + # @!attribute idempotency_key # Filter records to the one with the specified `idempotency_key` you chose for # that object. This value is unique across Increase and is used to ensure that a # request is only processed once. Learn more about @@ -56,114 +39,66 @@ class ACHTransferListParams < Increase::Internal::Type::BaseModel # @return [String, nil] optional :idempotency_key, String - # @!parse - # # @return [String] - # attr_writer :idempotency_key - - # @!attribute [r] limit + # @!attribute limit # Limit the size of the list that is returned. The default (and maximum) is 100 # objects. # # @return [Integer, nil] optional :limit, Integer - # @!parse - # # @return [Integer] - # attr_writer :limit - - # @!attribute [r] status + # @!attribute status # # @return [Increase::Models::ACHTransferListParams::Status, nil] optional :status, -> { Increase::Models::ACHTransferListParams::Status } - # @!parse - # # @return [Increase::Models::ACHTransferListParams::Status] - # attr_writer :status - - # @!parse - # # @param account_id [String] - # # @param created_at [Increase::Models::ACHTransferListParams::CreatedAt] - # # @param cursor [String] - # # @param external_account_id [String] - # # @param idempotency_key [String] - # # @param limit [Integer] - # # @param status [Increase::Models::ACHTransferListParams::Status] - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize( - # account_id: nil, - # created_at: nil, - # cursor: nil, - # external_account_id: nil, - # idempotency_key: nil, - # limit: nil, - # status: nil, - # request_options: {}, - # ** - # ) - # super - # end - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(account_id: nil, created_at: nil, cursor: nil, external_account_id: nil, idempotency_key: nil, limit: nil, status: nil, request_options: {}) + # @param account_id [String] + # @param created_at [Increase::Models::ACHTransferListParams::CreatedAt] + # @param cursor [String] + # @param external_account_id [String] + # @param idempotency_key [String] + # @param limit [Integer] + # @param status [Increase::Models::ACHTransferListParams::Status] + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] class CreatedAt < Increase::Internal::Type::BaseModel - # @!attribute [r] after + # @!attribute after # Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) # timestamp. # # @return [Time, nil] optional :after, Time - # @!parse - # # @return [Time] - # attr_writer :after - - # @!attribute [r] before + # @!attribute before # Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) # timestamp. # # @return [Time, nil] optional :before, Time - # @!parse - # # @return [Time] - # attr_writer :before - - # @!attribute [r] on_or_after + # @!attribute on_or_after # Return results on or after this # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. # # @return [Time, nil] optional :on_or_after, Time - # @!parse - # # @return [Time] - # attr_writer :on_or_after - - # @!attribute [r] on_or_before + # @!attribute on_or_before # Return results on or before this # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. # # @return [Time, nil] optional :on_or_before, Time - # @!parse - # # @return [Time] - # attr_writer :on_or_before - - # @!parse - # # @param after [Time] - # # @param before [Time] - # # @param on_or_after [Time] - # # @param on_or_before [Time] - # # - # def initialize(after: nil, before: nil, on_or_after: nil, on_or_before: nil, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(after: nil, before: nil, on_or_after: nil, on_or_before: nil) + # @param after [Time] + # @param before [Time] + # @param on_or_after [Time] + # @param on_or_before [Time] end class Status < Increase::Internal::Type::BaseModel - # @!attribute [r] in_ + # @!attribute in_ # Return results whose value is in the provided list. For GET requests, this # should be encoded as a comma-delimited string, such as `?in=one,two,three`. # @@ -172,16 +107,8 @@ class Status < Increase::Internal::Type::BaseModel -> { Increase::Internal::Type::ArrayOf[enum: Increase::Models::ACHTransferListParams::Status::In] }, api_name: :in - # @!parse - # # @return [Array] - # attr_writer :in_ - - # @!parse - # # @param in_ [Array] - # # - # def initialize(in_: nil, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(in_: nil) + # @param in_ [Array] module In extend Increase::Internal::Type::Enum @@ -213,11 +140,8 @@ module In # The transfer has been returned. RETURNED = :returned - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end diff --git a/lib/increase/models/ach_transfer_retrieve_params.rb b/lib/increase/models/ach_transfer_retrieve_params.rb index f8d0b2847..2ecc1d784 100644 --- a/lib/increase/models/ach_transfer_retrieve_params.rb +++ b/lib/increase/models/ach_transfer_retrieve_params.rb @@ -4,16 +4,11 @@ module Increase module Models # @see Increase::Resources::ACHTransfers#retrieve class ACHTransferRetrieveParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters - # @!parse - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(request_options: {}, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(request_options: {}) + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/increase/models/balance_lookup.rb b/lib/increase/models/balance_lookup.rb index 56f6920ef..8e7e0559f 100644 --- a/lib/increase/models/balance_lookup.rb +++ b/lib/increase/models/balance_lookup.rb @@ -31,18 +31,14 @@ class BalanceLookup < Increase::Internal::Type::BaseModel # @return [Symbol, Increase::Models::BalanceLookup::Type] required :type, enum: -> { Increase::Models::BalanceLookup::Type } - # @!parse - # # Represents a request to lookup the balance of an Account at a given point in - # # time. - # # - # # @param account_id [String] - # # @param available_balance [Integer] - # # @param current_balance [Integer] - # # @param type [Symbol, Increase::Models::BalanceLookup::Type] - # # - # def initialize(account_id:, available_balance:, current_balance:, type:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(account_id:, available_balance:, current_balance:, type:) + # Represents a request to lookup the balance of an Account at a given point in + # time. + # + # @param account_id [String] + # @param available_balance [Integer] + # @param current_balance [Integer] + # @param type [Symbol, Increase::Models::BalanceLookup::Type] # A constant representing the object's type. For this resource it will always be # `balance_lookup`. @@ -53,11 +49,8 @@ module Type BALANCE_LOOKUP = :balance_lookup - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end diff --git a/lib/increase/models/bookkeeping_account.rb b/lib/increase/models/bookkeeping_account.rb index 9d180a88e..5e6358431 100644 --- a/lib/increase/models/bookkeeping_account.rb +++ b/lib/increase/models/bookkeeping_account.rb @@ -51,22 +51,18 @@ class BookkeepingAccount < Increase::Internal::Type::BaseModel # @return [Symbol, Increase::Models::BookkeepingAccount::Type] required :type, enum: -> { Increase::Models::BookkeepingAccount::Type } - # @!parse - # # Accounts are T-accounts. They can store accounting entries. Your compliance - # # setup might require annotating money movements using this API. Learn more in our - # # [guide to Bookkeeping](https://increase.com/documentation/bookkeeping#bookkeeping). - # # - # # @param id [String] - # # @param account_id [String, nil] - # # @param compliance_category [Symbol, Increase::Models::BookkeepingAccount::ComplianceCategory, nil] - # # @param entity_id [String, nil] - # # @param idempotency_key [String, nil] - # # @param name [String] - # # @param type [Symbol, Increase::Models::BookkeepingAccount::Type] - # # - # def initialize(id:, account_id:, compliance_category:, entity_id:, idempotency_key:, name:, type:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(id:, account_id:, compliance_category:, entity_id:, idempotency_key:, name:, type:) + # Accounts are T-accounts. They can store accounting entries. Your compliance + # setup might require annotating money movements using this API. Learn more in our + # [guide to Bookkeeping](https://increase.com/documentation/bookkeeping#bookkeeping). + # + # @param id [String] + # @param account_id [String, nil] + # @param compliance_category [Symbol, Increase::Models::BookkeepingAccount::ComplianceCategory, nil] + # @param entity_id [String, nil] + # @param idempotency_key [String, nil] + # @param name [String] + # @param type [Symbol, Increase::Models::BookkeepingAccount::Type] # The compliance category of the account. # @@ -80,11 +76,8 @@ module ComplianceCategory # A customer balance. CUSTOMER_BALANCE = :customer_balance - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # A constant representing the object's type. For this resource it will always be @@ -96,11 +89,8 @@ module Type BOOKKEEPING_ACCOUNT = :bookkeeping_account - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end diff --git a/lib/increase/models/bookkeeping_account_balance_params.rb b/lib/increase/models/bookkeeping_account_balance_params.rb index decf0faf3..bfd3ff65d 100644 --- a/lib/increase/models/bookkeeping_account_balance_params.rb +++ b/lib/increase/models/bookkeeping_account_balance_params.rb @@ -4,27 +4,18 @@ module Increase module Models # @see Increase::Resources::BookkeepingAccounts#balance class BookkeepingAccountBalanceParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters - # @!attribute [r] at_time + # @!attribute at_time # The moment to query the balance at. If not set, returns the current balances. # # @return [Time, nil] optional :at_time, Time - # @!parse - # # @return [Time] - # attr_writer :at_time - - # @!parse - # # @param at_time [Time] - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(at_time: nil, request_options: {}, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(at_time: nil, request_options: {}) + # @param at_time [Time] + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/increase/models/bookkeeping_account_create_params.rb b/lib/increase/models/bookkeeping_account_create_params.rb index 6823ef552..e81050273 100644 --- a/lib/increase/models/bookkeeping_account_create_params.rb +++ b/lib/increase/models/bookkeeping_account_create_params.rb @@ -4,8 +4,7 @@ module Increase module Models # @see Increase::Resources::BookkeepingAccounts#create class BookkeepingAccountCreateParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters # @!attribute name @@ -14,47 +13,31 @@ class BookkeepingAccountCreateParams < Increase::Internal::Type::BaseModel # @return [String] required :name, String - # @!attribute [r] account_id + # @!attribute account_id # The entity, if `compliance_category` is `commingled_cash`. # # @return [String, nil] optional :account_id, String - # @!parse - # # @return [String] - # attr_writer :account_id - - # @!attribute [r] compliance_category + # @!attribute compliance_category # The account compliance category. # # @return [Symbol, Increase::Models::BookkeepingAccountCreateParams::ComplianceCategory, nil] optional :compliance_category, enum: -> { Increase::Models::BookkeepingAccountCreateParams::ComplianceCategory } - # @!parse - # # @return [Symbol, Increase::Models::BookkeepingAccountCreateParams::ComplianceCategory] - # attr_writer :compliance_category - - # @!attribute [r] entity_id + # @!attribute entity_id # The entity, if `compliance_category` is `customer_balance`. # # @return [String, nil] optional :entity_id, String - # @!parse - # # @return [String] - # attr_writer :entity_id - - # @!parse - # # @param name [String] - # # @param account_id [String] - # # @param compliance_category [Symbol, Increase::Models::BookkeepingAccountCreateParams::ComplianceCategory] - # # @param entity_id [String] - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(name:, account_id: nil, compliance_category: nil, entity_id: nil, request_options: {}, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(name:, account_id: nil, compliance_category: nil, entity_id: nil, request_options: {}) + # @param name [String] + # @param account_id [String] + # @param compliance_category [Symbol, Increase::Models::BookkeepingAccountCreateParams::ComplianceCategory] + # @param entity_id [String] + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] # The account compliance category. module ComplianceCategory @@ -66,11 +49,8 @@ module ComplianceCategory # A customer balance. CUSTOMER_BALANCE = :customer_balance - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end diff --git a/lib/increase/models/bookkeeping_account_list_params.rb b/lib/increase/models/bookkeeping_account_list_params.rb index 1e8708a4d..6ca67aa18 100644 --- a/lib/increase/models/bookkeeping_account_list_params.rb +++ b/lib/increase/models/bookkeeping_account_list_params.rb @@ -4,21 +4,16 @@ module Increase module Models # @see Increase::Resources::BookkeepingAccounts#list class BookkeepingAccountListParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters - # @!attribute [r] cursor + # @!attribute cursor # Return the page of entries after this one. # # @return [String, nil] optional :cursor, String - # @!parse - # # @return [String] - # attr_writer :cursor - - # @!attribute [r] idempotency_key + # @!attribute idempotency_key # Filter records to the one with the specified `idempotency_key` you chose for # that object. This value is unique across Increase and is used to ensure that a # request is only processed once. Learn more about @@ -27,30 +22,18 @@ class BookkeepingAccountListParams < Increase::Internal::Type::BaseModel # @return [String, nil] optional :idempotency_key, String - # @!parse - # # @return [String] - # attr_writer :idempotency_key - - # @!attribute [r] limit + # @!attribute limit # Limit the size of the list that is returned. The default (and maximum) is 100 # objects. # # @return [Integer, nil] optional :limit, Integer - # @!parse - # # @return [Integer] - # attr_writer :limit - - # @!parse - # # @param cursor [String] - # # @param idempotency_key [String] - # # @param limit [Integer] - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(cursor: nil, idempotency_key: nil, limit: nil, request_options: {}, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(cursor: nil, idempotency_key: nil, limit: nil, request_options: {}) + # @param cursor [String] + # @param idempotency_key [String] + # @param limit [Integer] + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/increase/models/bookkeeping_account_update_params.rb b/lib/increase/models/bookkeeping_account_update_params.rb index 85c7f1baa..68ba33baa 100644 --- a/lib/increase/models/bookkeeping_account_update_params.rb +++ b/lib/increase/models/bookkeeping_account_update_params.rb @@ -4,8 +4,7 @@ module Increase module Models # @see Increase::Resources::BookkeepingAccounts#update class BookkeepingAccountUpdateParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters # @!attribute name @@ -14,13 +13,9 @@ class BookkeepingAccountUpdateParams < Increase::Internal::Type::BaseModel # @return [String] required :name, String - # @!parse - # # @param name [String] - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(name:, request_options: {}, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(name:, request_options: {}) + # @param name [String] + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/increase/models/bookkeeping_balance_lookup.rb b/lib/increase/models/bookkeeping_balance_lookup.rb index 7b7809f87..8018eff14 100644 --- a/lib/increase/models/bookkeeping_balance_lookup.rb +++ b/lib/increase/models/bookkeeping_balance_lookup.rb @@ -24,17 +24,13 @@ class BookkeepingBalanceLookup < Increase::Internal::Type::BaseModel # @return [Symbol, Increase::Models::BookkeepingBalanceLookup::Type] required :type, enum: -> { Increase::Models::BookkeepingBalanceLookup::Type } - # @!parse - # # Represents a request to lookup the balance of an Bookkeeping Account at a given - # # point in time. - # # - # # @param balance [Integer] - # # @param bookkeeping_account_id [String] - # # @param type [Symbol, Increase::Models::BookkeepingBalanceLookup::Type] - # # - # def initialize(balance:, bookkeeping_account_id:, type:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(balance:, bookkeeping_account_id:, type:) + # Represents a request to lookup the balance of an Bookkeeping Account at a given + # point in time. + # + # @param balance [Integer] + # @param bookkeeping_account_id [String] + # @param type [Symbol, Increase::Models::BookkeepingBalanceLookup::Type] # A constant representing the object's type. For this resource it will always be # `bookkeeping_balance_lookup`. @@ -45,11 +41,8 @@ module Type BOOKKEEPING_BALANCE_LOOKUP = :bookkeeping_balance_lookup - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end diff --git a/lib/increase/models/bookkeeping_entry.rb b/lib/increase/models/bookkeeping_entry.rb index 39a38f66b..e12c77e6d 100644 --- a/lib/increase/models/bookkeeping_entry.rb +++ b/lib/increase/models/bookkeeping_entry.rb @@ -42,21 +42,17 @@ class BookkeepingEntry < Increase::Internal::Type::BaseModel # @return [Symbol, Increase::Models::BookkeepingEntry::Type] required :type, enum: -> { Increase::Models::BookkeepingEntry::Type } - # @!parse - # # Entries are T-account entries recording debits and credits. Your compliance - # # setup might require annotating money movements using this API. Learn more in our - # # [guide to Bookkeeping](https://increase.com/documentation/bookkeeping#bookkeeping). - # # - # # @param id [String] - # # @param account_id [String] - # # @param amount [Integer] - # # @param created_at [Time] - # # @param entry_set_id [String] - # # @param type [Symbol, Increase::Models::BookkeepingEntry::Type] - # # - # def initialize(id:, account_id:, amount:, created_at:, entry_set_id:, type:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(id:, account_id:, amount:, created_at:, entry_set_id:, type:) + # Entries are T-account entries recording debits and credits. Your compliance + # setup might require annotating money movements using this API. Learn more in our + # [guide to Bookkeeping](https://increase.com/documentation/bookkeeping#bookkeeping). + # + # @param id [String] + # @param account_id [String] + # @param amount [Integer] + # @param created_at [Time] + # @param entry_set_id [String] + # @param type [Symbol, Increase::Models::BookkeepingEntry::Type] # A constant representing the object's type. For this resource it will always be # `bookkeeping_entry`. @@ -67,11 +63,8 @@ module Type BOOKKEEPING_ENTRY = :bookkeeping_entry - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end diff --git a/lib/increase/models/bookkeeping_entry_list_params.rb b/lib/increase/models/bookkeeping_entry_list_params.rb index 53f0153a4..47aa09fd3 100644 --- a/lib/increase/models/bookkeeping_entry_list_params.rb +++ b/lib/increase/models/bookkeeping_entry_list_params.rb @@ -4,50 +4,33 @@ module Increase module Models # @see Increase::Resources::BookkeepingEntries#list class BookkeepingEntryListParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters - # @!attribute [r] account_id + # @!attribute account_id # The identifier for the Bookkeeping Account to filter by. # # @return [String, nil] optional :account_id, String - # @!parse - # # @return [String] - # attr_writer :account_id - - # @!attribute [r] cursor + # @!attribute cursor # Return the page of entries after this one. # # @return [String, nil] optional :cursor, String - # @!parse - # # @return [String] - # attr_writer :cursor - - # @!attribute [r] limit + # @!attribute limit # Limit the size of the list that is returned. The default (and maximum) is 100 # objects. # # @return [Integer, nil] optional :limit, Integer - # @!parse - # # @return [Integer] - # attr_writer :limit - - # @!parse - # # @param account_id [String] - # # @param cursor [String] - # # @param limit [Integer] - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(account_id: nil, cursor: nil, limit: nil, request_options: {}, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(account_id: nil, cursor: nil, limit: nil, request_options: {}) + # @param account_id [String] + # @param cursor [String] + # @param limit [Integer] + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/increase/models/bookkeeping_entry_retrieve_params.rb b/lib/increase/models/bookkeeping_entry_retrieve_params.rb index 398db547c..423dd7edc 100644 --- a/lib/increase/models/bookkeeping_entry_retrieve_params.rb +++ b/lib/increase/models/bookkeeping_entry_retrieve_params.rb @@ -4,16 +4,11 @@ module Increase module Models # @see Increase::Resources::BookkeepingEntries#retrieve class BookkeepingEntryRetrieveParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters - # @!parse - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(request_options: {}, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(request_options: {}) + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/increase/models/bookkeeping_entry_set.rb b/lib/increase/models/bookkeeping_entry_set.rb index 430d1b3cd..fecc59992 100644 --- a/lib/increase/models/bookkeeping_entry_set.rb +++ b/lib/increase/models/bookkeeping_entry_set.rb @@ -49,23 +49,19 @@ class BookkeepingEntrySet < Increase::Internal::Type::BaseModel # @return [Symbol, Increase::Models::BookkeepingEntrySet::Type] required :type, enum: -> { Increase::Models::BookkeepingEntrySet::Type } - # @!parse - # # Entry Sets are accounting entries that are transactionally applied. Your - # # compliance setup might require annotating money movements using this API. Learn - # # more in our - # # [guide to Bookkeeping](https://increase.com/documentation/bookkeeping#bookkeeping). - # # - # # @param id [String] - # # @param created_at [Time] - # # @param date [Time] - # # @param entries [Array] - # # @param idempotency_key [String, nil] - # # @param transaction_id [String, nil] - # # @param type [Symbol, Increase::Models::BookkeepingEntrySet::Type] - # # - # def initialize(id:, created_at:, date:, entries:, idempotency_key:, transaction_id:, type:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(id:, created_at:, date:, entries:, idempotency_key:, transaction_id:, type:) + # Entry Sets are accounting entries that are transactionally applied. Your + # compliance setup might require annotating money movements using this API. Learn + # more in our + # [guide to Bookkeeping](https://increase.com/documentation/bookkeeping#bookkeeping). + # + # @param id [String] + # @param created_at [Time] + # @param date [Time] + # @param entries [Array] + # @param idempotency_key [String, nil] + # @param transaction_id [String, nil] + # @param type [Symbol, Increase::Models::BookkeepingEntrySet::Type] class Entry < Increase::Internal::Type::BaseModel # @!attribute id @@ -86,14 +82,10 @@ class Entry < Increase::Internal::Type::BaseModel # @return [Integer] required :amount, Integer - # @!parse - # # @param id [String] - # # @param account_id [String] - # # @param amount [Integer] - # # - # def initialize(id:, account_id:, amount:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(id:, account_id:, amount:) + # @param id [String] + # @param account_id [String] + # @param amount [Integer] end # A constant representing the object's type. For this resource it will always be @@ -105,11 +97,8 @@ module Type BOOKKEEPING_ENTRY_SET = :bookkeeping_entry_set - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end diff --git a/lib/increase/models/bookkeeping_entry_set_create_params.rb b/lib/increase/models/bookkeeping_entry_set_create_params.rb index 794315e6d..c2a1ff1ad 100644 --- a/lib/increase/models/bookkeeping_entry_set_create_params.rb +++ b/lib/increase/models/bookkeeping_entry_set_create_params.rb @@ -4,8 +4,7 @@ module Increase module Models # @see Increase::Resources::BookkeepingEntrySets#create class BookkeepingEntrySetCreateParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters # @!attribute entries @@ -15,36 +14,24 @@ class BookkeepingEntrySetCreateParams < Increase::Internal::Type::BaseModel required :entries, -> { Increase::Internal::Type::ArrayOf[Increase::Models::BookkeepingEntrySetCreateParams::Entry] } - # @!attribute [r] date + # @!attribute date # The date of the transaction. Optional if `transaction_id` is provided, in which # case we use the `date` of that transaction. Required otherwise. # # @return [Time, nil] optional :date, Time - # @!parse - # # @return [Time] - # attr_writer :date - - # @!attribute [r] transaction_id + # @!attribute transaction_id # The identifier of the Transaction related to this entry set, if any. # # @return [String, nil] optional :transaction_id, String - # @!parse - # # @return [String] - # attr_writer :transaction_id - - # @!parse - # # @param entries [Array] - # # @param date [Time] - # # @param transaction_id [String] - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(entries:, date: nil, transaction_id: nil, request_options: {}, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(entries:, date: nil, transaction_id: nil, request_options: {}) + # @param entries [Array] + # @param date [Time] + # @param transaction_id [String] + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] class Entry < Increase::Internal::Type::BaseModel # @!attribute account_id @@ -61,13 +48,9 @@ class Entry < Increase::Internal::Type::BaseModel # @return [Integer] required :amount, Integer - # @!parse - # # @param account_id [String] - # # @param amount [Integer] - # # - # def initialize(account_id:, amount:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(account_id:, amount:) + # @param account_id [String] + # @param amount [Integer] end end end diff --git a/lib/increase/models/bookkeeping_entry_set_list_params.rb b/lib/increase/models/bookkeeping_entry_set_list_params.rb index 8c5dfc479..e38da0ca9 100644 --- a/lib/increase/models/bookkeeping_entry_set_list_params.rb +++ b/lib/increase/models/bookkeeping_entry_set_list_params.rb @@ -4,21 +4,16 @@ module Increase module Models # @see Increase::Resources::BookkeepingEntrySets#list class BookkeepingEntrySetListParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters - # @!attribute [r] cursor + # @!attribute cursor # Return the page of entries after this one. # # @return [String, nil] optional :cursor, String - # @!parse - # # @return [String] - # attr_writer :cursor - - # @!attribute [r] idempotency_key + # @!attribute idempotency_key # Filter records to the one with the specified `idempotency_key` you chose for # that object. This value is unique across Increase and is used to ensure that a # request is only processed once. Learn more about @@ -27,41 +22,25 @@ class BookkeepingEntrySetListParams < Increase::Internal::Type::BaseModel # @return [String, nil] optional :idempotency_key, String - # @!parse - # # @return [String] - # attr_writer :idempotency_key - - # @!attribute [r] limit + # @!attribute limit # Limit the size of the list that is returned. The default (and maximum) is 100 # objects. # # @return [Integer, nil] optional :limit, Integer - # @!parse - # # @return [Integer] - # attr_writer :limit - - # @!attribute [r] transaction_id + # @!attribute transaction_id # Filter to the Bookkeeping Entry Set that maps to this Transaction. # # @return [String, nil] optional :transaction_id, String - # @!parse - # # @return [String] - # attr_writer :transaction_id - - # @!parse - # # @param cursor [String] - # # @param idempotency_key [String] - # # @param limit [Integer] - # # @param transaction_id [String] - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(cursor: nil, idempotency_key: nil, limit: nil, transaction_id: nil, request_options: {}, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(cursor: nil, idempotency_key: nil, limit: nil, transaction_id: nil, request_options: {}) + # @param cursor [String] + # @param idempotency_key [String] + # @param limit [Integer] + # @param transaction_id [String] + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/increase/models/bookkeeping_entry_set_retrieve_params.rb b/lib/increase/models/bookkeeping_entry_set_retrieve_params.rb index 0c81d2b74..6e14f658a 100644 --- a/lib/increase/models/bookkeeping_entry_set_retrieve_params.rb +++ b/lib/increase/models/bookkeeping_entry_set_retrieve_params.rb @@ -4,16 +4,11 @@ module Increase module Models # @see Increase::Resources::BookkeepingEntrySets#retrieve class BookkeepingEntrySetRetrieveParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters - # @!parse - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(request_options: {}, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(request_options: {}) + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/increase/models/card.rb b/lib/increase/models/card.rb index 97a8c333e..04c1cf296 100644 --- a/lib/increase/models/card.rb +++ b/lib/increase/models/card.rb @@ -88,46 +88,25 @@ class Card < Increase::Internal::Type::BaseModel # @return [Symbol, Increase::Models::Card::Type] required :type, enum: -> { Increase::Models::Card::Type } - # @!parse - # # Cards are commercial credit cards. They'll immediately work for online purchases - # # after you create them. All cards maintain a credit limit of 100% of the - # # Account’s available balance at the time of transaction. Funds are deducted from - # # the Account upon transaction settlement. - # # - # # @param id [String] - # # @param account_id [String] - # # @param billing_address [Increase::Models::Card::BillingAddress] - # # @param created_at [Time] - # # @param description [String, nil] - # # @param digital_wallet [Increase::Models::Card::DigitalWallet, nil] - # # @param entity_id [String, nil] - # # @param expiration_month [Integer] - # # @param expiration_year [Integer] - # # @param idempotency_key [String, nil] - # # @param last4 [String] - # # @param status [Symbol, Increase::Models::Card::Status] - # # @param type [Symbol, Increase::Models::Card::Type] - # # - # def initialize( - # id:, - # account_id:, - # billing_address:, - # created_at:, - # description:, - # digital_wallet:, - # entity_id:, - # expiration_month:, - # expiration_year:, - # idempotency_key:, - # last4:, - # status:, - # type:, - # ** - # ) - # super - # end - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(id:, account_id:, billing_address:, created_at:, description:, digital_wallet:, entity_id:, expiration_month:, expiration_year:, idempotency_key:, last4:, status:, type:) + # Cards are commercial credit cards. They'll immediately work for online purchases + # after you create them. All cards maintain a credit limit of 100% of the + # Account’s available balance at the time of transaction. Funds are deducted from + # the Account upon transaction settlement. + # + # @param id [String] + # @param account_id [String] + # @param billing_address [Increase::Models::Card::BillingAddress] + # @param created_at [Time] + # @param description [String, nil] + # @param digital_wallet [Increase::Models::Card::DigitalWallet, nil] + # @param entity_id [String, nil] + # @param expiration_month [Integer] + # @param expiration_year [Integer] + # @param idempotency_key [String, nil] + # @param last4 [String] + # @param status [Symbol, Increase::Models::Card::Status] + # @param type [Symbol, Increase::Models::Card::Type] # @see Increase::Models::Card#billing_address class BillingAddress < Increase::Internal::Type::BaseModel @@ -161,18 +140,14 @@ class BillingAddress < Increase::Internal::Type::BaseModel # @return [String, nil] required :state, String, nil?: true - # @!parse - # # The Card's billing address. - # # - # # @param city [String, nil] - # # @param line1 [String, nil] - # # @param line2 [String, nil] - # # @param postal_code [String, nil] - # # @param state [String, nil] - # # - # def initialize(city:, line1:, line2:, postal_code:, state:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(city:, line1:, line2:, postal_code:, state:) + # The Card's billing address. + # + # @param city [String, nil] + # @param line1 [String, nil] + # @param line2 [String, nil] + # @param postal_code [String, nil] + # @param state [String, nil] end # @see Increase::Models::Card#digital_wallet @@ -198,18 +173,14 @@ class DigitalWallet < Increase::Internal::Type::BaseModel # @return [String, nil] required :phone, String, nil?: true - # @!parse - # # The contact information used in the two-factor steps for digital wallet card - # # creation. At least one field must be present to complete the digital wallet - # # steps. - # # - # # @param digital_card_profile_id [String, nil] - # # @param email [String, nil] - # # @param phone [String, nil] - # # - # def initialize(digital_card_profile_id:, email:, phone:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(digital_card_profile_id:, email:, phone:) + # The contact information used in the two-factor steps for digital wallet card + # creation. At least one field must be present to complete the digital wallet + # steps. + # + # @param digital_card_profile_id [String, nil] + # @param email [String, nil] + # @param phone [String, nil] end # This indicates if payments can be made with the card. @@ -227,11 +198,8 @@ module Status # The card is permanently canceled. CANCELED = :canceled - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # A constant representing the object's type. For this resource it will always be @@ -243,11 +211,8 @@ module Type CARD = :card - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end diff --git a/lib/increase/models/card_create_params.rb b/lib/increase/models/card_create_params.rb index 113f51c56..6d4974dda 100644 --- a/lib/increase/models/card_create_params.rb +++ b/lib/increase/models/card_create_params.rb @@ -4,8 +4,7 @@ module Increase module Models # @see Increase::Resources::Cards#create class CardCreateParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters # @!attribute account_id @@ -14,27 +13,19 @@ class CardCreateParams < Increase::Internal::Type::BaseModel # @return [String] required :account_id, String - # @!attribute [r] billing_address + # @!attribute billing_address # The card's billing address. # # @return [Increase::Models::CardCreateParams::BillingAddress, nil] optional :billing_address, -> { Increase::Models::CardCreateParams::BillingAddress } - # @!parse - # # @return [Increase::Models::CardCreateParams::BillingAddress] - # attr_writer :billing_address - - # @!attribute [r] description + # @!attribute description # The description you choose to give the card. # # @return [String, nil] optional :description, String - # @!parse - # # @return [String] - # attr_writer :description - - # @!attribute [r] digital_wallet + # @!attribute digital_wallet # The contact information used in the two-factor steps for digital wallet card # creation. To add the card to a digital wallet, you may supply an email or phone # number with this request. Otherwise, subscribe and then action a Real Time @@ -44,42 +35,20 @@ class CardCreateParams < Increase::Internal::Type::BaseModel # @return [Increase::Models::CardCreateParams::DigitalWallet, nil] optional :digital_wallet, -> { Increase::Models::CardCreateParams::DigitalWallet } - # @!parse - # # @return [Increase::Models::CardCreateParams::DigitalWallet] - # attr_writer :digital_wallet - - # @!attribute [r] entity_id + # @!attribute entity_id # The Entity the card belongs to. You only need to supply this in rare situations # when the card is not for the Account holder. # # @return [String, nil] optional :entity_id, String - # @!parse - # # @return [String] - # attr_writer :entity_id - - # @!parse - # # @param account_id [String] - # # @param billing_address [Increase::Models::CardCreateParams::BillingAddress] - # # @param description [String] - # # @param digital_wallet [Increase::Models::CardCreateParams::DigitalWallet] - # # @param entity_id [String] - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize( - # account_id:, - # billing_address: nil, - # description: nil, - # digital_wallet: nil, - # entity_id: nil, - # request_options: {}, - # ** - # ) - # super - # end - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(account_id:, billing_address: nil, description: nil, digital_wallet: nil, entity_id: nil, request_options: {}) + # @param account_id [String] + # @param billing_address [Increase::Models::CardCreateParams::BillingAddress] + # @param description [String] + # @param digital_wallet [Increase::Models::CardCreateParams::DigitalWallet] + # @param entity_id [String] + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] class BillingAddress < Increase::Internal::Type::BaseModel # @!attribute city @@ -106,77 +75,53 @@ class BillingAddress < Increase::Internal::Type::BaseModel # @return [String] required :state, String - # @!attribute [r] line2 + # @!attribute line2 # The second line of the billing address. # # @return [String, nil] optional :line2, String - # @!parse - # # @return [String] - # attr_writer :line2 - - # @!parse - # # The card's billing address. - # # - # # @param city [String] - # # @param line1 [String] - # # @param postal_code [String] - # # @param state [String] - # # @param line2 [String] - # # - # def initialize(city:, line1:, postal_code:, state:, line2: nil, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(city:, line1:, postal_code:, state:, line2: nil) + # The card's billing address. + # + # @param city [String] + # @param line1 [String] + # @param postal_code [String] + # @param state [String] + # @param line2 [String] end class DigitalWallet < Increase::Internal::Type::BaseModel - # @!attribute [r] digital_card_profile_id + # @!attribute digital_card_profile_id # The digital card profile assigned to this digital card. # # @return [String, nil] optional :digital_card_profile_id, String - # @!parse - # # @return [String] - # attr_writer :digital_card_profile_id - - # @!attribute [r] email + # @!attribute email # An email address that can be used to contact and verify the cardholder via # one-time passcode over email. # # @return [String, nil] optional :email, String - # @!parse - # # @return [String] - # attr_writer :email - - # @!attribute [r] phone + # @!attribute phone # A phone number that can be used to contact and verify the cardholder via # one-time passcode over SMS. # # @return [String, nil] optional :phone, String - # @!parse - # # @return [String] - # attr_writer :phone - - # @!parse - # # The contact information used in the two-factor steps for digital wallet card - # # creation. To add the card to a digital wallet, you may supply an email or phone - # # number with this request. Otherwise, subscribe and then action a Real Time - # # Decision with the category `digital_wallet_token_requested` or - # # `digital_wallet_authentication_requested`. - # # - # # @param digital_card_profile_id [String] - # # @param email [String] - # # @param phone [String] - # # - # def initialize(digital_card_profile_id: nil, email: nil, phone: nil, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(digital_card_profile_id: nil, email: nil, phone: nil) + # The contact information used in the two-factor steps for digital wallet card + # creation. To add the card to a digital wallet, you may supply an email or phone + # number with this request. Otherwise, subscribe and then action a Real Time + # Decision with the category `digital_wallet_token_requested` or + # `digital_wallet_authentication_requested`. + # + # @param digital_card_profile_id [String] + # @param email [String] + # @param phone [String] end end end diff --git a/lib/increase/models/card_details.rb b/lib/increase/models/card_details.rb index f1dc47030..bd85fbc2f 100644 --- a/lib/increase/models/card_details.rb +++ b/lib/increase/models/card_details.rb @@ -43,19 +43,15 @@ class CardDetails < Increase::Internal::Type::BaseModel # @return [String] required :verification_code, String - # @!parse - # # An object containing the sensitive details (card number, cvc, etc) for a Card. - # # - # # @param card_id [String] - # # @param expiration_month [Integer] - # # @param expiration_year [Integer] - # # @param primary_account_number [String] - # # @param type [Symbol, Increase::Models::CardDetails::Type] - # # @param verification_code [String] - # # - # def initialize(card_id:, expiration_month:, expiration_year:, primary_account_number:, type:, verification_code:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(card_id:, expiration_month:, expiration_year:, primary_account_number:, type:, verification_code:) + # An object containing the sensitive details (card number, cvc, etc) for a Card. + # + # @param card_id [String] + # @param expiration_month [Integer] + # @param expiration_year [Integer] + # @param primary_account_number [String] + # @param type [Symbol, Increase::Models::CardDetails::Type] + # @param verification_code [String] # A constant representing the object's type. For this resource it will always be # `card_details`. @@ -66,11 +62,8 @@ module Type CARD_DETAILS = :card_details - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end diff --git a/lib/increase/models/card_details_params.rb b/lib/increase/models/card_details_params.rb index 9c5bca993..cee0ffd0d 100644 --- a/lib/increase/models/card_details_params.rb +++ b/lib/increase/models/card_details_params.rb @@ -4,16 +4,11 @@ module Increase module Models # @see Increase::Resources::Cards#details class CardDetailsParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters - # @!parse - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(request_options: {}, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(request_options: {}) + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/increase/models/card_dispute.rb b/lib/increase/models/card_dispute.rb index 5913ba117..9c0dcca5d 100644 --- a/lib/increase/models/card_dispute.rb +++ b/lib/increase/models/card_dispute.rb @@ -84,42 +84,22 @@ class CardDispute < Increase::Internal::Type::BaseModel # @return [Increase::Models::CardDispute::Win, nil] required :win, -> { Increase::Models::CardDispute::Win }, nil?: true - # @!parse - # # If unauthorized activity occurs on a card, you can create a Card Dispute and - # # we'll return the funds if appropriate. - # # - # # @param id [String] - # # @param acceptance [Increase::Models::CardDispute::Acceptance, nil] - # # @param amount [Integer, nil] - # # @param created_at [Time] - # # @param disputed_transaction_id [String] - # # @param explanation [String] - # # @param idempotency_key [String, nil] - # # @param loss [Increase::Models::CardDispute::Loss, nil] - # # @param rejection [Increase::Models::CardDispute::Rejection, nil] - # # @param status [Symbol, Increase::Models::CardDispute::Status] - # # @param type [Symbol, Increase::Models::CardDispute::Type] - # # @param win [Increase::Models::CardDispute::Win, nil] - # # - # def initialize( - # id:, - # acceptance:, - # amount:, - # created_at:, - # disputed_transaction_id:, - # explanation:, - # idempotency_key:, - # loss:, - # rejection:, - # status:, - # type:, - # win:, - # ** - # ) - # super - # end - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(id:, acceptance:, amount:, created_at:, disputed_transaction_id:, explanation:, idempotency_key:, loss:, rejection:, status:, type:, win:) + # If unauthorized activity occurs on a card, you can create a Card Dispute and + # we'll return the funds if appropriate. + # + # @param id [String] + # @param acceptance [Increase::Models::CardDispute::Acceptance, nil] + # @param amount [Integer, nil] + # @param created_at [Time] + # @param disputed_transaction_id [String] + # @param explanation [String] + # @param idempotency_key [String, nil] + # @param loss [Increase::Models::CardDispute::Loss, nil] + # @param rejection [Increase::Models::CardDispute::Rejection, nil] + # @param status [Symbol, Increase::Models::CardDispute::Status] + # @param type [Symbol, Increase::Models::CardDispute::Type] + # @param win [Increase::Models::CardDispute::Win, nil] # @see Increase::Models::CardDispute#acceptance class Acceptance < Increase::Internal::Type::BaseModel @@ -143,17 +123,13 @@ class Acceptance < Increase::Internal::Type::BaseModel # @return [String] required :transaction_id, String - # @!parse - # # If the Card Dispute's status is `accepted`, this will contain details of the - # # successful dispute. - # # - # # @param accepted_at [Time] - # # @param card_dispute_id [String] - # # @param transaction_id [String] - # # - # def initialize(accepted_at:, card_dispute_id:, transaction_id:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(accepted_at:, card_dispute_id:, transaction_id:) + # If the Card Dispute's status is `accepted`, this will contain details of the + # successful dispute. + # + # @param accepted_at [Time] + # @param card_dispute_id [String] + # @param transaction_id [String] end # @see Increase::Models::CardDispute#loss @@ -184,18 +160,14 @@ class Loss < Increase::Internal::Type::BaseModel # @return [String] required :transaction_id, String - # @!parse - # # If the Card Dispute's status is `lost`, this will contain details of the lost - # # dispute. - # # - # # @param card_dispute_id [String] - # # @param explanation [String] - # # @param lost_at [Time] - # # @param transaction_id [String] - # # - # def initialize(card_dispute_id:, explanation:, lost_at:, transaction_id:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(card_dispute_id:, explanation:, lost_at:, transaction_id:) + # If the Card Dispute's status is `lost`, this will contain details of the lost + # dispute. + # + # @param card_dispute_id [String] + # @param explanation [String] + # @param lost_at [Time] + # @param transaction_id [String] end # @see Increase::Models::CardDispute#rejection @@ -219,17 +191,13 @@ class Rejection < Increase::Internal::Type::BaseModel # @return [Time] required :rejected_at, Time - # @!parse - # # If the Card Dispute's status is `rejected`, this will contain details of the - # # unsuccessful dispute. - # # - # # @param card_dispute_id [String] - # # @param explanation [String] - # # @param rejected_at [Time] - # # - # def initialize(card_dispute_id:, explanation:, rejected_at:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(card_dispute_id:, explanation:, rejected_at:) + # If the Card Dispute's status is `rejected`, this will contain details of the + # unsuccessful dispute. + # + # @param card_dispute_id [String] + # @param explanation [String] + # @param rejected_at [Time] end # The results of the Dispute investigation. @@ -256,11 +224,8 @@ module Status # The Card Dispute has been won and no further action can be taken. WON = :won - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # A constant representing the object's type. For this resource it will always be @@ -272,11 +237,8 @@ module Type CARD_DISPUTE = :card_dispute - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Increase::Models::CardDispute#win @@ -294,16 +256,12 @@ class Win < Increase::Internal::Type::BaseModel # @return [Time] required :won_at, Time - # @!parse - # # If the Card Dispute's status is `won`, this will contain details of the won - # # dispute. - # # - # # @param card_dispute_id [String] - # # @param won_at [Time] - # # - # def initialize(card_dispute_id:, won_at:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(card_dispute_id:, won_at:) + # If the Card Dispute's status is `won`, this will contain details of the won + # dispute. + # + # @param card_dispute_id [String] + # @param won_at [Time] end end end diff --git a/lib/increase/models/card_dispute_create_params.rb b/lib/increase/models/card_dispute_create_params.rb index 996ee91e8..451fcb514 100644 --- a/lib/increase/models/card_dispute_create_params.rb +++ b/lib/increase/models/card_dispute_create_params.rb @@ -4,8 +4,7 @@ module Increase module Models # @see Increase::Resources::CardDisputes#create class CardDisputeCreateParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters # @!attribute disputed_transaction_id @@ -21,7 +20,7 @@ class CardDisputeCreateParams < Increase::Internal::Type::BaseModel # @return [String] required :explanation, String - # @!attribute [r] amount + # @!attribute amount # The monetary amount of the part of the transaction that is being disputed. This # is optional and will default to the full amount of the transaction if not # provided. If provided, the amount must be less than or equal to the amount of @@ -30,19 +29,11 @@ class CardDisputeCreateParams < Increase::Internal::Type::BaseModel # @return [Integer, nil] optional :amount, Integer - # @!parse - # # @return [Integer] - # attr_writer :amount - - # @!parse - # # @param disputed_transaction_id [String] - # # @param explanation [String] - # # @param amount [Integer] - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(disputed_transaction_id:, explanation:, amount: nil, request_options: {}, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(disputed_transaction_id:, explanation:, amount: nil, request_options: {}) + # @param disputed_transaction_id [String] + # @param explanation [String] + # @param amount [Integer] + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/increase/models/card_dispute_list_params.rb b/lib/increase/models/card_dispute_list_params.rb index 5bac4f731..441ae8e4e 100644 --- a/lib/increase/models/card_dispute_list_params.rb +++ b/lib/increase/models/card_dispute_list_params.rb @@ -4,30 +4,21 @@ module Increase module Models # @see Increase::Resources::CardDisputes#list class CardDisputeListParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters - # @!attribute [r] created_at + # @!attribute created_at # # @return [Increase::Models::CardDisputeListParams::CreatedAt, nil] optional :created_at, -> { Increase::Models::CardDisputeListParams::CreatedAt } - # @!parse - # # @return [Increase::Models::CardDisputeListParams::CreatedAt] - # attr_writer :created_at - - # @!attribute [r] cursor + # @!attribute cursor # Return the page of entries after this one. # # @return [String, nil] optional :cursor, String - # @!parse - # # @return [String] - # attr_writer :cursor - - # @!attribute [r] idempotency_key + # @!attribute idempotency_key # Filter records to the one with the specified `idempotency_key` you chose for # that object. This value is unique across Increase and is used to ensure that a # request is only processed once. Learn more about @@ -36,100 +27,64 @@ class CardDisputeListParams < Increase::Internal::Type::BaseModel # @return [String, nil] optional :idempotency_key, String - # @!parse - # # @return [String] - # attr_writer :idempotency_key - - # @!attribute [r] limit + # @!attribute limit # Limit the size of the list that is returned. The default (and maximum) is 100 # objects. # # @return [Integer, nil] optional :limit, Integer - # @!parse - # # @return [Integer] - # attr_writer :limit - - # @!attribute [r] status + # @!attribute status # # @return [Increase::Models::CardDisputeListParams::Status, nil] optional :status, -> { Increase::Models::CardDisputeListParams::Status } - # @!parse - # # @return [Increase::Models::CardDisputeListParams::Status] - # attr_writer :status - - # @!parse - # # @param created_at [Increase::Models::CardDisputeListParams::CreatedAt] - # # @param cursor [String] - # # @param idempotency_key [String] - # # @param limit [Integer] - # # @param status [Increase::Models::CardDisputeListParams::Status] - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(created_at: nil, cursor: nil, idempotency_key: nil, limit: nil, status: nil, request_options: {}, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(created_at: nil, cursor: nil, idempotency_key: nil, limit: nil, status: nil, request_options: {}) + # @param created_at [Increase::Models::CardDisputeListParams::CreatedAt] + # @param cursor [String] + # @param idempotency_key [String] + # @param limit [Integer] + # @param status [Increase::Models::CardDisputeListParams::Status] + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] class CreatedAt < Increase::Internal::Type::BaseModel - # @!attribute [r] after + # @!attribute after # Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) # timestamp. # # @return [Time, nil] optional :after, Time - # @!parse - # # @return [Time] - # attr_writer :after - - # @!attribute [r] before + # @!attribute before # Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) # timestamp. # # @return [Time, nil] optional :before, Time - # @!parse - # # @return [Time] - # attr_writer :before - - # @!attribute [r] on_or_after + # @!attribute on_or_after # Return results on or after this # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. # # @return [Time, nil] optional :on_or_after, Time - # @!parse - # # @return [Time] - # attr_writer :on_or_after - - # @!attribute [r] on_or_before + # @!attribute on_or_before # Return results on or before this # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. # # @return [Time, nil] optional :on_or_before, Time - # @!parse - # # @return [Time] - # attr_writer :on_or_before - - # @!parse - # # @param after [Time] - # # @param before [Time] - # # @param on_or_after [Time] - # # @param on_or_before [Time] - # # - # def initialize(after: nil, before: nil, on_or_after: nil, on_or_before: nil, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(after: nil, before: nil, on_or_after: nil, on_or_before: nil) + # @param after [Time] + # @param before [Time] + # @param on_or_after [Time] + # @param on_or_before [Time] end class Status < Increase::Internal::Type::BaseModel - # @!attribute [r] in_ + # @!attribute in_ # Filter Card Disputes for those with the specified status or statuses. For GET # requests, this should be encoded as a comma-delimited string, such as # `?in=one,two,three`. @@ -139,16 +94,8 @@ class Status < Increase::Internal::Type::BaseModel -> { Increase::Internal::Type::ArrayOf[enum: Increase::Models::CardDisputeListParams::Status::In] }, api_name: :in - # @!parse - # # @return [Array] - # attr_writer :in_ - - # @!parse - # # @param in_ [Array] - # # - # def initialize(in_: nil, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(in_: nil) + # @param in_ [Array] module In extend Increase::Internal::Type::Enum @@ -171,11 +118,8 @@ module In # The Card Dispute has been won and no further action can be taken. WON = :won - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end diff --git a/lib/increase/models/card_dispute_retrieve_params.rb b/lib/increase/models/card_dispute_retrieve_params.rb index 6aa0b612d..6cf746d86 100644 --- a/lib/increase/models/card_dispute_retrieve_params.rb +++ b/lib/increase/models/card_dispute_retrieve_params.rb @@ -4,16 +4,11 @@ module Increase module Models # @see Increase::Resources::CardDisputes#retrieve class CardDisputeRetrieveParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters - # @!parse - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(request_options: {}, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(request_options: {}) + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/increase/models/card_list_params.rb b/lib/increase/models/card_list_params.rb index 5682bbb63..ea0db4a6e 100644 --- a/lib/increase/models/card_list_params.rb +++ b/lib/increase/models/card_list_params.rb @@ -4,40 +4,27 @@ module Increase module Models # @see Increase::Resources::Cards#list class CardListParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters - # @!attribute [r] account_id + # @!attribute account_id # Filter Cards to ones belonging to the specified Account. # # @return [String, nil] optional :account_id, String - # @!parse - # # @return [String] - # attr_writer :account_id - - # @!attribute [r] created_at + # @!attribute created_at # # @return [Increase::Models::CardListParams::CreatedAt, nil] optional :created_at, -> { Increase::Models::CardListParams::CreatedAt } - # @!parse - # # @return [Increase::Models::CardListParams::CreatedAt] - # attr_writer :created_at - - # @!attribute [r] cursor + # @!attribute cursor # Return the page of entries after this one. # # @return [String, nil] optional :cursor, String - # @!parse - # # @return [String] - # attr_writer :cursor - - # @!attribute [r] idempotency_key + # @!attribute idempotency_key # Filter records to the one with the specified `idempotency_key` you chose for # that object. This value is unique across Increase and is used to ensure that a # request is only processed once. Learn more about @@ -46,112 +33,65 @@ class CardListParams < Increase::Internal::Type::BaseModel # @return [String, nil] optional :idempotency_key, String - # @!parse - # # @return [String] - # attr_writer :idempotency_key - - # @!attribute [r] limit + # @!attribute limit # Limit the size of the list that is returned. The default (and maximum) is 100 # objects. # # @return [Integer, nil] optional :limit, Integer - # @!parse - # # @return [Integer] - # attr_writer :limit - - # @!attribute [r] status + # @!attribute status # # @return [Increase::Models::CardListParams::Status, nil] optional :status, -> { Increase::Models::CardListParams::Status } - # @!parse - # # @return [Increase::Models::CardListParams::Status] - # attr_writer :status - - # @!parse - # # @param account_id [String] - # # @param created_at [Increase::Models::CardListParams::CreatedAt] - # # @param cursor [String] - # # @param idempotency_key [String] - # # @param limit [Integer] - # # @param status [Increase::Models::CardListParams::Status] - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize( - # account_id: nil, - # created_at: nil, - # cursor: nil, - # idempotency_key: nil, - # limit: nil, - # status: nil, - # request_options: {}, - # ** - # ) - # super - # end - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(account_id: nil, created_at: nil, cursor: nil, idempotency_key: nil, limit: nil, status: nil, request_options: {}) + # @param account_id [String] + # @param created_at [Increase::Models::CardListParams::CreatedAt] + # @param cursor [String] + # @param idempotency_key [String] + # @param limit [Integer] + # @param status [Increase::Models::CardListParams::Status] + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] class CreatedAt < Increase::Internal::Type::BaseModel - # @!attribute [r] after + # @!attribute after # Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) # timestamp. # # @return [Time, nil] optional :after, Time - # @!parse - # # @return [Time] - # attr_writer :after - - # @!attribute [r] before + # @!attribute before # Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) # timestamp. # # @return [Time, nil] optional :before, Time - # @!parse - # # @return [Time] - # attr_writer :before - - # @!attribute [r] on_or_after + # @!attribute on_or_after # Return results on or after this # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. # # @return [Time, nil] optional :on_or_after, Time - # @!parse - # # @return [Time] - # attr_writer :on_or_after - - # @!attribute [r] on_or_before + # @!attribute on_or_before # Return results on or before this # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. # # @return [Time, nil] optional :on_or_before, Time - # @!parse - # # @return [Time] - # attr_writer :on_or_before - - # @!parse - # # @param after [Time] - # # @param before [Time] - # # @param on_or_after [Time] - # # @param on_or_before [Time] - # # - # def initialize(after: nil, before: nil, on_or_after: nil, on_or_before: nil, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(after: nil, before: nil, on_or_after: nil, on_or_before: nil) + # @param after [Time] + # @param before [Time] + # @param on_or_after [Time] + # @param on_or_before [Time] end class Status < Increase::Internal::Type::BaseModel - # @!attribute [r] in_ + # @!attribute in_ # Filter Cards by status. For GET requests, this should be encoded as a # comma-delimited string, such as `?in=one,two,three`. # @@ -160,16 +100,8 @@ class Status < Increase::Internal::Type::BaseModel -> { Increase::Internal::Type::ArrayOf[enum: Increase::Models::CardListParams::Status::In] }, api_name: :in - # @!parse - # # @return [Array] - # attr_writer :in_ - - # @!parse - # # @param in_ [Array] - # # - # def initialize(in_: nil, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(in_: nil) + # @param in_ [Array] module In extend Increase::Internal::Type::Enum @@ -183,11 +115,8 @@ module In # The card is permanently canceled. CANCELED = :canceled - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end diff --git a/lib/increase/models/card_payment.rb b/lib/increase/models/card_payment.rb index 30b2af826..16b092439 100644 --- a/lib/increase/models/card_payment.rb +++ b/lib/increase/models/card_payment.rb @@ -60,36 +60,19 @@ class CardPayment < Increase::Internal::Type::BaseModel # @return [Symbol, Increase::Models::CardPayment::Type] required :type, enum: -> { Increase::Models::CardPayment::Type } - # @!parse - # # Card Payments group together interactions related to a single card payment, such - # # as an authorization and its corresponding settlement. - # # - # # @param id [String] - # # @param account_id [String] - # # @param card_id [String] - # # @param created_at [Time] - # # @param digital_wallet_token_id [String, nil] - # # @param elements [Array] - # # @param physical_card_id [String, nil] - # # @param state [Increase::Models::CardPayment::State] - # # @param type [Symbol, Increase::Models::CardPayment::Type] - # # - # def initialize( - # id:, - # account_id:, - # card_id:, - # created_at:, - # digital_wallet_token_id:, - # elements:, - # physical_card_id:, - # state:, - # type:, - # ** - # ) - # super - # end - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(id:, account_id:, card_id:, created_at:, digital_wallet_token_id:, elements:, physical_card_id:, state:, type:) + # Card Payments group together interactions related to a single card payment, such + # as an authorization and its corresponding settlement. + # + # @param id [String] + # @param account_id [String] + # @param card_id [String] + # @param created_at [Time] + # @param digital_wallet_token_id [String, nil] + # @param elements [Array] + # @param physical_card_id [String, nil] + # @param state [Increase::Models::CardPayment::State] + # @param type [Symbol, Increase::Models::CardPayment::Type] class Element < Increase::Internal::Type::BaseModel # @!attribute card_authentication @@ -206,41 +189,20 @@ class Element < Increase::Internal::Type::BaseModel # @return [Object, nil] required :other, Increase::Internal::Type::Unknown, nil?: true - # @!parse - # # @param card_authentication [Increase::Models::CardPayment::Element::CardAuthentication, nil] - # # @param card_authorization [Increase::Models::CardPayment::Element::CardAuthorization, nil] - # # @param card_authorization_expiration [Increase::Models::CardPayment::Element::CardAuthorizationExpiration, nil] - # # @param card_decline [Increase::Models::CardPayment::Element::CardDecline, nil] - # # @param card_fuel_confirmation [Increase::Models::CardPayment::Element::CardFuelConfirmation, nil] - # # @param card_increment [Increase::Models::CardPayment::Element::CardIncrement, nil] - # # @param card_refund [Increase::Models::CardPayment::Element::CardRefund, nil] - # # @param card_reversal [Increase::Models::CardPayment::Element::CardReversal, nil] - # # @param card_settlement [Increase::Models::CardPayment::Element::CardSettlement, nil] - # # @param card_validation [Increase::Models::CardPayment::Element::CardValidation, nil] - # # @param category [Symbol, Increase::Models::CardPayment::Element::Category] - # # @param created_at [Time] - # # @param other [Object, nil] - # # - # def initialize( - # card_authentication:, - # card_authorization:, - # card_authorization_expiration:, - # card_decline:, - # card_fuel_confirmation:, - # card_increment:, - # card_refund:, - # card_reversal:, - # card_settlement:, - # card_validation:, - # category:, - # created_at:, - # other:, - # ** - # ) - # super - # end - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(card_authentication:, card_authorization:, card_authorization_expiration:, card_decline:, card_fuel_confirmation:, card_increment:, card_refund:, card_reversal:, card_settlement:, card_validation:, category:, created_at:, other:) + # @param card_authentication [Increase::Models::CardPayment::Element::CardAuthentication, nil] + # @param card_authorization [Increase::Models::CardPayment::Element::CardAuthorization, nil] + # @param card_authorization_expiration [Increase::Models::CardPayment::Element::CardAuthorizationExpiration, nil] + # @param card_decline [Increase::Models::CardPayment::Element::CardDecline, nil] + # @param card_fuel_confirmation [Increase::Models::CardPayment::Element::CardFuelConfirmation, nil] + # @param card_increment [Increase::Models::CardPayment::Element::CardIncrement, nil] + # @param card_refund [Increase::Models::CardPayment::Element::CardRefund, nil] + # @param card_reversal [Increase::Models::CardPayment::Element::CardReversal, nil] + # @param card_settlement [Increase::Models::CardPayment::Element::CardSettlement, nil] + # @param card_validation [Increase::Models::CardPayment::Element::CardValidation, nil] + # @param category [Symbol, Increase::Models::CardPayment::Element::Category] + # @param created_at [Time] + # @param other [Object, nil] # @see Increase::Models::CardPayment::Element#card_authentication class CardAuthentication < Increase::Internal::Type::BaseModel @@ -360,53 +322,28 @@ class CardAuthentication < Increase::Internal::Type::BaseModel # @return [Symbol, Increase::Models::CardPayment::Element::CardAuthentication::Type] required :type, enum: -> { Increase::Models::CardPayment::Element::CardAuthentication::Type } - # @!parse - # # A Card Authentication object. This field will be present in the JSON response if - # # and only if `category` is equal to `card_authentication`. Card Authentications - # # are attempts to authenticate a transaction or a card with 3DS. - # # - # # @param id [String] - # # @param card_id [String] - # # @param card_payment_id [String] - # # @param category [Symbol, Increase::Models::CardPayment::Element::CardAuthentication::Category, nil] - # # @param challenge [Increase::Models::CardPayment::Element::CardAuthentication::Challenge, nil] - # # @param created_at [Time] - # # @param deny_reason [Symbol, Increase::Models::CardPayment::Element::CardAuthentication::DenyReason, nil] - # # @param device_channel [Symbol, Increase::Models::CardPayment::Element::CardAuthentication::DeviceChannel, nil] - # # @param merchant_acceptor_id [String] - # # @param merchant_category_code [String] - # # @param merchant_country [String] - # # @param merchant_name [String] - # # @param purchase_amount [Integer, nil] - # # @param purchase_currency [String, nil] - # # @param real_time_decision_id [String, nil] - # # @param status [Symbol, Increase::Models::CardPayment::Element::CardAuthentication::Status] - # # @param type [Symbol, Increase::Models::CardPayment::Element::CardAuthentication::Type] - # # - # def initialize( - # id:, - # card_id:, - # card_payment_id:, - # category:, - # challenge:, - # created_at:, - # deny_reason:, - # device_channel:, - # merchant_acceptor_id:, - # merchant_category_code:, - # merchant_country:, - # merchant_name:, - # purchase_amount:, - # purchase_currency:, - # real_time_decision_id:, - # status:, - # type:, - # ** - # ) - # super - # end - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(id:, card_id:, card_payment_id:, category:, challenge:, created_at:, deny_reason:, device_channel:, merchant_acceptor_id:, merchant_category_code:, merchant_country:, merchant_name:, purchase_amount:, purchase_currency:, real_time_decision_id:, status:, type:) + # A Card Authentication object. This field will be present in the JSON response if + # and only if `category` is equal to `card_authentication`. Card Authentications + # are attempts to authenticate a transaction or a card with 3DS. + # + # @param id [String] + # @param card_id [String] + # @param card_payment_id [String] + # @param category [Symbol, Increase::Models::CardPayment::Element::CardAuthentication::Category, nil] + # @param challenge [Increase::Models::CardPayment::Element::CardAuthentication::Challenge, nil] + # @param created_at [Time] + # @param deny_reason [Symbol, Increase::Models::CardPayment::Element::CardAuthentication::DenyReason, nil] + # @param device_channel [Symbol, Increase::Models::CardPayment::Element::CardAuthentication::DeviceChannel, nil] + # @param merchant_acceptor_id [String] + # @param merchant_category_code [String] + # @param merchant_country [String] + # @param merchant_name [String] + # @param purchase_amount [Integer, nil] + # @param purchase_currency [String, nil] + # @param real_time_decision_id [String, nil] + # @param status [Symbol, Increase::Models::CardPayment::Element::CardAuthentication::Status] + # @param type [Symbol, Increase::Models::CardPayment::Element::CardAuthentication::Type] # The category of the card authentication attempt. # @@ -420,11 +357,8 @@ module Category # The authentication attempt is not for a payment. NON_PAYMENT_AUTHENTICATION = :non_payment_authentication - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Increase::Models::CardPayment::Element::CardAuthentication#challenge @@ -463,18 +397,14 @@ class Challenge < Increase::Internal::Type::BaseModel # @return [String, nil] required :verification_value, String, nil?: true - # @!parse - # # Details about the challenge, if one was requested. - # # - # # @param attempts [Array] - # # @param created_at [Time] - # # @param one_time_code [String] - # # @param verification_method [Symbol, Increase::Models::CardPayment::Element::CardAuthentication::Challenge::VerificationMethod] - # # @param verification_value [String, nil] - # # - # def initialize(attempts:, created_at:, one_time_code:, verification_method:, verification_value:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(attempts:, created_at:, one_time_code:, verification_method:, verification_value:) + # Details about the challenge, if one was requested. + # + # @param attempts [Array] + # @param created_at [Time] + # @param one_time_code [String] + # @param verification_method [Symbol, Increase::Models::CardPayment::Element::CardAuthentication::Challenge::VerificationMethod] + # @param verification_value [String, nil] class Attempt < Increase::Internal::Type::BaseModel # @!attribute created_at @@ -491,13 +421,9 @@ class Attempt < Increase::Internal::Type::BaseModel required :outcome, enum: -> { Increase::Models::CardPayment::Element::CardAuthentication::Challenge::Attempt::Outcome } - # @!parse - # # @param created_at [Time] - # # @param outcome [Symbol, Increase::Models::CardPayment::Element::CardAuthentication::Challenge::Attempt::Outcome] - # # - # def initialize(created_at:, outcome:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(created_at:, outcome:) + # @param created_at [Time] + # @param outcome [Symbol, Increase::Models::CardPayment::Element::CardAuthentication::Challenge::Attempt::Outcome] # The outcome of the Card Authentication Challenge Attempt. # @@ -511,11 +437,8 @@ module Outcome # The attempt was unsuccessful. FAILED = :failed - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -534,11 +457,8 @@ module VerificationMethod # The one-time code was not successfully delivered. NONE_AVAILABLE = :none_available - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -566,11 +486,8 @@ module DenyReason # The webhook timed out. WEBHOOK_TIMED_OUT = :webhook_timed_out - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # The device channel of the card authentication attempt. @@ -588,11 +505,8 @@ module DeviceChannel # The authentication attempt was initiated by the 3DS Requestor. THREE_DS_REQUESTOR_INITIATED = :three_ds_requestor_initiated - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # The status of the card authentication. @@ -628,11 +542,8 @@ module Status # The authentication attempt exceeded the attempt threshold. EXCEEDED_ATTEMPT_THRESHOLD = :exceeded_attempt_threshold - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # A constant representing the object's type. For this resource it will always be @@ -644,11 +555,8 @@ module Type CARD_AUTHENTICATION = :card_authentication - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -835,74 +743,39 @@ class CardAuthorization < Increase::Internal::Type::BaseModel # @return [Increase::Models::CardPayment::Element::CardAuthorization::Verification] required :verification, -> { Increase::Models::CardPayment::Element::CardAuthorization::Verification } - # @!parse - # # A Card Authorization object. This field will be present in the JSON response if - # # and only if `category` is equal to `card_authorization`. Card Authorizations are - # # temporary holds placed on a customers funds with the intent to later clear a - # # transaction. - # # - # # @param id [String] - # # @param actioner [Symbol, Increase::Models::CardPayment::Element::CardAuthorization::Actioner] - # # @param amount [Integer] - # # @param card_payment_id [String] - # # @param currency [Symbol, Increase::Models::CardPayment::Element::CardAuthorization::Currency] - # # @param digital_wallet_token_id [String, nil] - # # @param direction [Symbol, Increase::Models::CardPayment::Element::CardAuthorization::Direction] - # # @param expires_at [Time] - # # @param merchant_acceptor_id [String] - # # @param merchant_category_code [String] - # # @param merchant_city [String, nil] - # # @param merchant_country [String] - # # @param merchant_descriptor [String] - # # @param merchant_postal_code [String, nil] - # # @param merchant_state [String, nil] - # # @param network_details [Increase::Models::CardPayment::Element::CardAuthorization::NetworkDetails] - # # @param network_identifiers [Increase::Models::CardPayment::Element::CardAuthorization::NetworkIdentifiers] - # # @param network_risk_score [Integer, nil] - # # @param pending_transaction_id [String, nil] - # # @param physical_card_id [String, nil] - # # @param presentment_amount [Integer] - # # @param presentment_currency [String] - # # @param processing_category [Symbol, Increase::Models::CardPayment::Element::CardAuthorization::ProcessingCategory] - # # @param real_time_decision_id [String, nil] - # # @param terminal_id [String, nil] - # # @param type [Symbol, Increase::Models::CardPayment::Element::CardAuthorization::Type] - # # @param verification [Increase::Models::CardPayment::Element::CardAuthorization::Verification] - # # - # def initialize( - # id:, - # actioner:, - # amount:, - # card_payment_id:, - # currency:, - # digital_wallet_token_id:, - # direction:, - # expires_at:, - # merchant_acceptor_id:, - # merchant_category_code:, - # merchant_city:, - # merchant_country:, - # merchant_descriptor:, - # merchant_postal_code:, - # merchant_state:, - # network_details:, - # network_identifiers:, - # network_risk_score:, - # pending_transaction_id:, - # physical_card_id:, - # presentment_amount:, - # presentment_currency:, - # processing_category:, - # real_time_decision_id:, - # terminal_id:, - # type:, - # verification:, - # ** - # ) - # super - # end - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(id:, actioner:, amount:, card_payment_id:, currency:, digital_wallet_token_id:, direction:, expires_at:, merchant_acceptor_id:, merchant_category_code:, merchant_city:, merchant_country:, merchant_descriptor:, merchant_postal_code:, merchant_state:, network_details:, network_identifiers:, network_risk_score:, pending_transaction_id:, physical_card_id:, presentment_amount:, presentment_currency:, processing_category:, real_time_decision_id:, terminal_id:, type:, verification:) + # A Card Authorization object. This field will be present in the JSON response if + # and only if `category` is equal to `card_authorization`. Card Authorizations are + # temporary holds placed on a customers funds with the intent to later clear a + # transaction. + # + # @param id [String] + # @param actioner [Symbol, Increase::Models::CardPayment::Element::CardAuthorization::Actioner] + # @param amount [Integer] + # @param card_payment_id [String] + # @param currency [Symbol, Increase::Models::CardPayment::Element::CardAuthorization::Currency] + # @param digital_wallet_token_id [String, nil] + # @param direction [Symbol, Increase::Models::CardPayment::Element::CardAuthorization::Direction] + # @param expires_at [Time] + # @param merchant_acceptor_id [String] + # @param merchant_category_code [String] + # @param merchant_city [String, nil] + # @param merchant_country [String] + # @param merchant_descriptor [String] + # @param merchant_postal_code [String, nil] + # @param merchant_state [String, nil] + # @param network_details [Increase::Models::CardPayment::Element::CardAuthorization::NetworkDetails] + # @param network_identifiers [Increase::Models::CardPayment::Element::CardAuthorization::NetworkIdentifiers] + # @param network_risk_score [Integer, nil] + # @param pending_transaction_id [String, nil] + # @param physical_card_id [String, nil] + # @param presentment_amount [Integer] + # @param presentment_currency [String] + # @param processing_category [Symbol, Increase::Models::CardPayment::Element::CardAuthorization::ProcessingCategory] + # @param real_time_decision_id [String, nil] + # @param terminal_id [String, nil] + # @param type [Symbol, Increase::Models::CardPayment::Element::CardAuthorization::Type] + # @param verification [Increase::Models::CardPayment::Element::CardAuthorization::Verification] # Whether this authorization was approved by Increase, the card network through # stand-in processing, or the user through a real-time decision. @@ -920,11 +793,8 @@ module Actioner # This object was actioned by the network, through stand-in processing. NETWORK = :network - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the @@ -952,11 +822,8 @@ module Currency # US Dollar (USD) USD = :USD - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # The direction describes the direction the funds will move, either from the @@ -972,11 +839,8 @@ module Direction # A refund card authorization, sometimes referred to as a credit voucher authorization, where funds are credited to the cardholder. REFUND = :refund - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Increase::Models::CardPayment::Element::CardAuthorization#network_details @@ -996,15 +860,11 @@ class NetworkDetails < Increase::Internal::Type::BaseModel -> { Increase::Models::CardPayment::Element::CardAuthorization::NetworkDetails::Visa }, nil?: true - # @!parse - # # Fields specific to the `network`. - # # - # # @param category [Symbol, Increase::Models::CardPayment::Element::CardAuthorization::NetworkDetails::Category] - # # @param visa [Increase::Models::CardPayment::Element::CardAuthorization::NetworkDetails::Visa, nil] - # # - # def initialize(category:, visa:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(category:, visa:) + # Fields specific to the `network`. + # + # @param category [Symbol, Increase::Models::CardPayment::Element::CardAuthorization::NetworkDetails::Category] + # @param visa [Increase::Models::CardPayment::Element::CardAuthorization::NetworkDetails::Visa, nil] # The payment network used to process this card authorization. # @@ -1015,11 +875,8 @@ module Category # Visa VISA = :visa - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Increase::Models::CardPayment::Element::CardAuthorization::NetworkDetails#visa @@ -1052,16 +909,12 @@ class Visa < Increase::Internal::Type::BaseModel enum: -> { Increase::Models::CardPayment::Element::CardAuthorization::NetworkDetails::Visa::StandInProcessingReason }, nil?: true - # @!parse - # # Fields specific to the `visa` network. - # # - # # @param electronic_commerce_indicator [Symbol, Increase::Models::CardPayment::Element::CardAuthorization::NetworkDetails::Visa::ElectronicCommerceIndicator, nil] - # # @param point_of_service_entry_mode [Symbol, Increase::Models::CardPayment::Element::CardAuthorization::NetworkDetails::Visa::PointOfServiceEntryMode, nil] - # # @param stand_in_processing_reason [Symbol, Increase::Models::CardPayment::Element::CardAuthorization::NetworkDetails::Visa::StandInProcessingReason, nil] - # # - # def initialize(electronic_commerce_indicator:, point_of_service_entry_mode:, stand_in_processing_reason:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(electronic_commerce_indicator:, point_of_service_entry_mode:, stand_in_processing_reason:) + # Fields specific to the `visa` network. + # + # @param electronic_commerce_indicator [Symbol, Increase::Models::CardPayment::Element::CardAuthorization::NetworkDetails::Visa::ElectronicCommerceIndicator, nil] + # @param point_of_service_entry_mode [Symbol, Increase::Models::CardPayment::Element::CardAuthorization::NetworkDetails::Visa::PointOfServiceEntryMode, nil] + # @param stand_in_processing_reason [Symbol, Increase::Models::CardPayment::Element::CardAuthorization::NetworkDetails::Visa::StandInProcessingReason, nil] # For electronic commerce transactions, this identifies the level of security used # in obtaining the customer's payment credential. For mail or telephone order @@ -1096,11 +949,8 @@ module ElectronicCommerceIndicator # Non-secure transaction: Use to identify an electronic commerce transaction that has no data protection. NON_SECURE_TRANSACTION = :non_secure_transaction - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # The method used to enter the cardholder's primary account number and card @@ -1140,11 +990,8 @@ module PointOfServiceEntryMode # Contact chip card, without card verification value INTEGRATED_CIRCUIT_CARD_NO_CVV = :integrated_circuit_card_no_cvv - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # Only present when `actioner: network`. Describes why a card authorization was @@ -1177,11 +1024,8 @@ module StandInProcessingReason # An unspecific reason for stand-in processing. OTHER = :other - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -1210,16 +1054,12 @@ class NetworkIdentifiers < Increase::Internal::Type::BaseModel # @return [String, nil] required :transaction_id, String, nil?: true - # @!parse - # # Network-specific identifiers for a specific request or transaction. - # # - # # @param retrieval_reference_number [String, nil] - # # @param trace_number [String, nil] - # # @param transaction_id [String, nil] - # # - # def initialize(retrieval_reference_number:, trace_number:, transaction_id:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(retrieval_reference_number:, trace_number:, transaction_id:) + # Network-specific identifiers for a specific request or transaction. + # + # @param retrieval_reference_number [String, nil] + # @param trace_number [String, nil] + # @param transaction_id [String, nil] end # The processing category describes the intent behind the authorization, such as @@ -1247,11 +1087,8 @@ module ProcessingCategory # A refund card authorization, sometimes referred to as a credit voucher authorization, where funds are credited to the cardholder. REFUND = :refund - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # A constant representing the object's type. For this resource it will always be @@ -1263,11 +1100,8 @@ module Type CARD_AUTHORIZATION = :card_authorization - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Increase::Models::CardPayment::Element::CardAuthorization#verification @@ -1288,15 +1122,11 @@ class Verification < Increase::Internal::Type::BaseModel required :cardholder_address, -> { Increase::Models::CardPayment::Element::CardAuthorization::Verification::CardholderAddress } - # @!parse - # # Fields related to verification of cardholder-provided values. - # # - # # @param card_verification_code [Increase::Models::CardPayment::Element::CardAuthorization::Verification::CardVerificationCode] - # # @param cardholder_address [Increase::Models::CardPayment::Element::CardAuthorization::Verification::CardholderAddress] - # # - # def initialize(card_verification_code:, cardholder_address:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(card_verification_code:, cardholder_address:) + # Fields related to verification of cardholder-provided values. + # + # @param card_verification_code [Increase::Models::CardPayment::Element::CardAuthorization::Verification::CardVerificationCode] + # @param cardholder_address [Increase::Models::CardPayment::Element::CardAuthorization::Verification::CardholderAddress] # @see Increase::Models::CardPayment::Element::CardAuthorization::Verification#card_verification_code class CardVerificationCode < Increase::Internal::Type::BaseModel @@ -1307,15 +1137,11 @@ class CardVerificationCode < Increase::Internal::Type::BaseModel required :result, enum: -> { Increase::Models::CardPayment::Element::CardAuthorization::Verification::CardVerificationCode::Result } - # @!parse - # # Fields related to verification of the Card Verification Code, a 3-digit code on - # # the back of the card. - # # - # # @param result [Symbol, Increase::Models::CardPayment::Element::CardAuthorization::Verification::CardVerificationCode::Result] - # # - # def initialize(result:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(result:) + # Fields related to verification of the Card Verification Code, a 3-digit code on + # the back of the card. + # + # @param result [Symbol, Increase::Models::CardPayment::Element::CardAuthorization::Verification::CardVerificationCode::Result] # The result of verifying the Card Verification Code. # @@ -1332,11 +1158,8 @@ module Result # The card verification code did not match the one on file. NO_MATCH = :no_match - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -1374,19 +1197,15 @@ class CardholderAddress < Increase::Internal::Type::BaseModel required :result, enum: -> { Increase::Models::CardPayment::Element::CardAuthorization::Verification::CardholderAddress::Result } - # @!parse - # # Cardholder address provided in the authorization request and the address on file - # # we verified it against. - # # - # # @param actual_line1 [String, nil] - # # @param actual_postal_code [String, nil] - # # @param provided_line1 [String, nil] - # # @param provided_postal_code [String, nil] - # # @param result [Symbol, Increase::Models::CardPayment::Element::CardAuthorization::Verification::CardholderAddress::Result] - # # - # def initialize(actual_line1:, actual_postal_code:, provided_line1:, provided_postal_code:, result:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(actual_line1:, actual_postal_code:, provided_line1:, provided_postal_code:, result:) + # Cardholder address provided in the authorization request and the address on file + # we verified it against. + # + # @param actual_line1 [String, nil] + # @param actual_postal_code [String, nil] + # @param provided_line1 [String, nil] + # @param provided_postal_code [String, nil] + # @param result [Symbol, Increase::Models::CardPayment::Element::CardAuthorization::Verification::CardholderAddress::Result] # The address verification result returned to the card network. # @@ -1412,11 +1231,8 @@ module Result # Postal code and street address do not match. NO_MATCH = :no_match - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -1465,22 +1281,18 @@ class CardAuthorizationExpiration < Increase::Internal::Type::BaseModel # @return [Symbol, Increase::Models::CardPayment::Element::CardAuthorizationExpiration::Type] required :type, enum: -> { Increase::Models::CardPayment::Element::CardAuthorizationExpiration::Type } - # @!parse - # # A Card Authorization Expiration object. This field will be present in the JSON - # # response if and only if `category` is equal to `card_authorization_expiration`. - # # Card Authorization Expirations are cancellations of authorizations that were - # # never settled by the acquirer. - # # - # # @param id [String] - # # @param card_authorization_id [String] - # # @param currency [Symbol, Increase::Models::CardPayment::Element::CardAuthorizationExpiration::Currency] - # # @param expired_amount [Integer] - # # @param network [Symbol, Increase::Models::CardPayment::Element::CardAuthorizationExpiration::Network] - # # @param type [Symbol, Increase::Models::CardPayment::Element::CardAuthorizationExpiration::Type] - # # - # def initialize(id:, card_authorization_id:, currency:, expired_amount:, network:, type:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(id:, card_authorization_id:, currency:, expired_amount:, network:, type:) + # A Card Authorization Expiration object. This field will be present in the JSON + # response if and only if `category` is equal to `card_authorization_expiration`. + # Card Authorization Expirations are cancellations of authorizations that were + # never settled by the acquirer. + # + # @param id [String] + # @param card_authorization_id [String] + # @param currency [Symbol, Increase::Models::CardPayment::Element::CardAuthorizationExpiration::Currency] + # @param expired_amount [Integer] + # @param network [Symbol, Increase::Models::CardPayment::Element::CardAuthorizationExpiration::Network] + # @param type [Symbol, Increase::Models::CardPayment::Element::CardAuthorizationExpiration::Type] # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the reversal's # currency. @@ -1507,11 +1319,8 @@ module Currency # US Dollar (USD) USD = :USD - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # The card network used to process this card authorization. @@ -1523,11 +1332,8 @@ module Network # Visa VISA = :visa - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # A constant representing the object's type. For this resource it will always be @@ -1539,11 +1345,8 @@ module Type CARD_AUTHORIZATION_EXPIRATION = :card_authorization_expiration - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -1730,72 +1533,37 @@ class CardDecline < Increase::Internal::Type::BaseModel # @return [Increase::Models::CardPayment::Element::CardDecline::Verification] required :verification, -> { Increase::Models::CardPayment::Element::CardDecline::Verification } - # @!parse - # # A Card Decline object. This field will be present in the JSON response if and - # # only if `category` is equal to `card_decline`. - # # - # # @param id [String] - # # @param actioner [Symbol, Increase::Models::CardPayment::Element::CardDecline::Actioner] - # # @param amount [Integer] - # # @param card_payment_id [String] - # # @param currency [Symbol, Increase::Models::CardPayment::Element::CardDecline::Currency] - # # @param declined_transaction_id [String] - # # @param digital_wallet_token_id [String, nil] - # # @param direction [Symbol, Increase::Models::CardPayment::Element::CardDecline::Direction] - # # @param merchant_acceptor_id [String] - # # @param merchant_category_code [String] - # # @param merchant_city [String, nil] - # # @param merchant_country [String] - # # @param merchant_descriptor [String] - # # @param merchant_postal_code [String, nil] - # # @param merchant_state [String, nil] - # # @param network_details [Increase::Models::CardPayment::Element::CardDecline::NetworkDetails] - # # @param network_identifiers [Increase::Models::CardPayment::Element::CardDecline::NetworkIdentifiers] - # # @param network_risk_score [Integer, nil] - # # @param physical_card_id [String, nil] - # # @param presentment_amount [Integer] - # # @param presentment_currency [String] - # # @param processing_category [Symbol, Increase::Models::CardPayment::Element::CardDecline::ProcessingCategory] - # # @param real_time_decision_id [String, nil] - # # @param real_time_decision_reason [Symbol, Increase::Models::CardPayment::Element::CardDecline::RealTimeDecisionReason, nil] - # # @param reason [Symbol, Increase::Models::CardPayment::Element::CardDecline::Reason] - # # @param terminal_id [String, nil] - # # @param verification [Increase::Models::CardPayment::Element::CardDecline::Verification] - # # - # def initialize( - # id:, - # actioner:, - # amount:, - # card_payment_id:, - # currency:, - # declined_transaction_id:, - # digital_wallet_token_id:, - # direction:, - # merchant_acceptor_id:, - # merchant_category_code:, - # merchant_city:, - # merchant_country:, - # merchant_descriptor:, - # merchant_postal_code:, - # merchant_state:, - # network_details:, - # network_identifiers:, - # network_risk_score:, - # physical_card_id:, - # presentment_amount:, - # presentment_currency:, - # processing_category:, - # real_time_decision_id:, - # real_time_decision_reason:, - # reason:, - # terminal_id:, - # verification:, - # ** - # ) - # super - # end - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(id:, actioner:, amount:, card_payment_id:, currency:, declined_transaction_id:, digital_wallet_token_id:, direction:, merchant_acceptor_id:, merchant_category_code:, merchant_city:, merchant_country:, merchant_descriptor:, merchant_postal_code:, merchant_state:, network_details:, network_identifiers:, network_risk_score:, physical_card_id:, presentment_amount:, presentment_currency:, processing_category:, real_time_decision_id:, real_time_decision_reason:, reason:, terminal_id:, verification:) + # A Card Decline object. This field will be present in the JSON response if and + # only if `category` is equal to `card_decline`. + # + # @param id [String] + # @param actioner [Symbol, Increase::Models::CardPayment::Element::CardDecline::Actioner] + # @param amount [Integer] + # @param card_payment_id [String] + # @param currency [Symbol, Increase::Models::CardPayment::Element::CardDecline::Currency] + # @param declined_transaction_id [String] + # @param digital_wallet_token_id [String, nil] + # @param direction [Symbol, Increase::Models::CardPayment::Element::CardDecline::Direction] + # @param merchant_acceptor_id [String] + # @param merchant_category_code [String] + # @param merchant_city [String, nil] + # @param merchant_country [String] + # @param merchant_descriptor [String] + # @param merchant_postal_code [String, nil] + # @param merchant_state [String, nil] + # @param network_details [Increase::Models::CardPayment::Element::CardDecline::NetworkDetails] + # @param network_identifiers [Increase::Models::CardPayment::Element::CardDecline::NetworkIdentifiers] + # @param network_risk_score [Integer, nil] + # @param physical_card_id [String, nil] + # @param presentment_amount [Integer] + # @param presentment_currency [String] + # @param processing_category [Symbol, Increase::Models::CardPayment::Element::CardDecline::ProcessingCategory] + # @param real_time_decision_id [String, nil] + # @param real_time_decision_reason [Symbol, Increase::Models::CardPayment::Element::CardDecline::RealTimeDecisionReason, nil] + # @param reason [Symbol, Increase::Models::CardPayment::Element::CardDecline::Reason] + # @param terminal_id [String, nil] + # @param verification [Increase::Models::CardPayment::Element::CardDecline::Verification] # Whether this authorization was approved by Increase, the card network through # stand-in processing, or the user through a real-time decision. @@ -1813,11 +1581,8 @@ module Actioner # This object was actioned by the network, through stand-in processing. NETWORK = :network - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the destination @@ -1845,11 +1610,8 @@ module Currency # US Dollar (USD) USD = :USD - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # The direction describes the direction the funds will move, either from the @@ -1865,11 +1627,8 @@ module Direction # A refund card authorization, sometimes referred to as a credit voucher authorization, where funds are credited to the cardholder. REFUND = :refund - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Increase::Models::CardPayment::Element::CardDecline#network_details @@ -1889,15 +1648,11 @@ class NetworkDetails < Increase::Internal::Type::BaseModel -> { Increase::Models::CardPayment::Element::CardDecline::NetworkDetails::Visa }, nil?: true - # @!parse - # # Fields specific to the `network`. - # # - # # @param category [Symbol, Increase::Models::CardPayment::Element::CardDecline::NetworkDetails::Category] - # # @param visa [Increase::Models::CardPayment::Element::CardDecline::NetworkDetails::Visa, nil] - # # - # def initialize(category:, visa:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(category:, visa:) + # Fields specific to the `network`. + # + # @param category [Symbol, Increase::Models::CardPayment::Element::CardDecline::NetworkDetails::Category] + # @param visa [Increase::Models::CardPayment::Element::CardDecline::NetworkDetails::Visa, nil] # The payment network used to process this card authorization. # @@ -1908,11 +1663,8 @@ module Category # Visa VISA = :visa - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Increase::Models::CardPayment::Element::CardDecline::NetworkDetails#visa @@ -1945,16 +1697,12 @@ class Visa < Increase::Internal::Type::BaseModel enum: -> { Increase::Models::CardPayment::Element::CardDecline::NetworkDetails::Visa::StandInProcessingReason }, nil?: true - # @!parse - # # Fields specific to the `visa` network. - # # - # # @param electronic_commerce_indicator [Symbol, Increase::Models::CardPayment::Element::CardDecline::NetworkDetails::Visa::ElectronicCommerceIndicator, nil] - # # @param point_of_service_entry_mode [Symbol, Increase::Models::CardPayment::Element::CardDecline::NetworkDetails::Visa::PointOfServiceEntryMode, nil] - # # @param stand_in_processing_reason [Symbol, Increase::Models::CardPayment::Element::CardDecline::NetworkDetails::Visa::StandInProcessingReason, nil] - # # - # def initialize(electronic_commerce_indicator:, point_of_service_entry_mode:, stand_in_processing_reason:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(electronic_commerce_indicator:, point_of_service_entry_mode:, stand_in_processing_reason:) + # Fields specific to the `visa` network. + # + # @param electronic_commerce_indicator [Symbol, Increase::Models::CardPayment::Element::CardDecline::NetworkDetails::Visa::ElectronicCommerceIndicator, nil] + # @param point_of_service_entry_mode [Symbol, Increase::Models::CardPayment::Element::CardDecline::NetworkDetails::Visa::PointOfServiceEntryMode, nil] + # @param stand_in_processing_reason [Symbol, Increase::Models::CardPayment::Element::CardDecline::NetworkDetails::Visa::StandInProcessingReason, nil] # For electronic commerce transactions, this identifies the level of security used # in obtaining the customer's payment credential. For mail or telephone order @@ -1989,11 +1737,8 @@ module ElectronicCommerceIndicator # Non-secure transaction: Use to identify an electronic commerce transaction that has no data protection. NON_SECURE_TRANSACTION = :non_secure_transaction - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # The method used to enter the cardholder's primary account number and card @@ -2033,11 +1778,8 @@ module PointOfServiceEntryMode # Contact chip card, without card verification value INTEGRATED_CIRCUIT_CARD_NO_CVV = :integrated_circuit_card_no_cvv - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # Only present when `actioner: network`. Describes why a card authorization was @@ -2070,11 +1812,8 @@ module StandInProcessingReason # An unspecific reason for stand-in processing. OTHER = :other - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -2103,16 +1842,12 @@ class NetworkIdentifiers < Increase::Internal::Type::BaseModel # @return [String, nil] required :transaction_id, String, nil?: true - # @!parse - # # Network-specific identifiers for a specific request or transaction. - # # - # # @param retrieval_reference_number [String, nil] - # # @param trace_number [String, nil] - # # @param transaction_id [String, nil] - # # - # def initialize(retrieval_reference_number:, trace_number:, transaction_id:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(retrieval_reference_number:, trace_number:, transaction_id:) + # Network-specific identifiers for a specific request or transaction. + # + # @param retrieval_reference_number [String, nil] + # @param trace_number [String, nil] + # @param transaction_id [String, nil] end # The processing category describes the intent behind the authorization, such as @@ -2140,11 +1875,8 @@ module ProcessingCategory # A refund card authorization, sometimes referred to as a credit voucher authorization, where funds are credited to the cardholder. REFUND = :refund - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # This is present if a specific decline reason was given in the real-time @@ -2172,11 +1904,8 @@ module RealTimeDecisionReason # The transaction was declined for another reason. The merchant may attempt to process the transaction again. This should be used sparingly. OTHER = :other - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # Why the transaction was declined. @@ -2233,14 +1962,14 @@ module Reason # The original card authorization for this incremental authorization does not exist. MISSING_ORIGINAL_AUTHORIZATION = :missing_original_authorization + # The transaction was declined because the 3DS authentication failed. + FAILED_3DS_AUTHENTICATION = :failed_3ds_authentication + # The transaction was suspected to be fraudulent. Please reach out to support@increase.com for more information. SUSPECTED_FRAUD = :suspected_fraud - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Increase::Models::CardPayment::Element::CardDecline#verification @@ -2261,15 +1990,11 @@ class Verification < Increase::Internal::Type::BaseModel required :cardholder_address, -> { Increase::Models::CardPayment::Element::CardDecline::Verification::CardholderAddress } - # @!parse - # # Fields related to verification of cardholder-provided values. - # # - # # @param card_verification_code [Increase::Models::CardPayment::Element::CardDecline::Verification::CardVerificationCode] - # # @param cardholder_address [Increase::Models::CardPayment::Element::CardDecline::Verification::CardholderAddress] - # # - # def initialize(card_verification_code:, cardholder_address:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(card_verification_code:, cardholder_address:) + # Fields related to verification of cardholder-provided values. + # + # @param card_verification_code [Increase::Models::CardPayment::Element::CardDecline::Verification::CardVerificationCode] + # @param cardholder_address [Increase::Models::CardPayment::Element::CardDecline::Verification::CardholderAddress] # @see Increase::Models::CardPayment::Element::CardDecline::Verification#card_verification_code class CardVerificationCode < Increase::Internal::Type::BaseModel @@ -2280,15 +2005,11 @@ class CardVerificationCode < Increase::Internal::Type::BaseModel required :result, enum: -> { Increase::Models::CardPayment::Element::CardDecline::Verification::CardVerificationCode::Result } - # @!parse - # # Fields related to verification of the Card Verification Code, a 3-digit code on - # # the back of the card. - # # - # # @param result [Symbol, Increase::Models::CardPayment::Element::CardDecline::Verification::CardVerificationCode::Result] - # # - # def initialize(result:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(result:) + # Fields related to verification of the Card Verification Code, a 3-digit code on + # the back of the card. + # + # @param result [Symbol, Increase::Models::CardPayment::Element::CardDecline::Verification::CardVerificationCode::Result] # The result of verifying the Card Verification Code. # @@ -2305,11 +2026,8 @@ module Result # The card verification code did not match the one on file. NO_MATCH = :no_match - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -2347,19 +2065,15 @@ class CardholderAddress < Increase::Internal::Type::BaseModel required :result, enum: -> { Increase::Models::CardPayment::Element::CardDecline::Verification::CardholderAddress::Result } - # @!parse - # # Cardholder address provided in the authorization request and the address on file - # # we verified it against. - # # - # # @param actual_line1 [String, nil] - # # @param actual_postal_code [String, nil] - # # @param provided_line1 [String, nil] - # # @param provided_postal_code [String, nil] - # # @param result [Symbol, Increase::Models::CardPayment::Element::CardDecline::Verification::CardholderAddress::Result] - # # - # def initialize(actual_line1:, actual_postal_code:, provided_line1:, provided_postal_code:, result:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(actual_line1:, actual_postal_code:, provided_line1:, provided_postal_code:, result:) + # Cardholder address provided in the authorization request and the address on file + # we verified it against. + # + # @param actual_line1 [String, nil] + # @param actual_postal_code [String, nil] + # @param provided_line1 [String, nil] + # @param provided_postal_code [String, nil] + # @param result [Symbol, Increase::Models::CardPayment::Element::CardDecline::Verification::CardholderAddress::Result] # The address verification result returned to the card network. # @@ -2385,11 +2099,8 @@ module Result # Postal code and street address do not match. NO_MATCH = :no_match - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -2450,36 +2161,20 @@ class CardFuelConfirmation < Increase::Internal::Type::BaseModel # @return [Integer] required :updated_authorization_amount, Integer - # @!parse - # # A Card Fuel Confirmation object. This field will be present in the JSON response - # # if and only if `category` is equal to `card_fuel_confirmation`. Card Fuel - # # Confirmations update the amount of a Card Authorization after a fuel pump - # # transaction is completed. - # # - # # @param id [String] - # # @param card_authorization_id [String] - # # @param currency [Symbol, Increase::Models::CardPayment::Element::CardFuelConfirmation::Currency] - # # @param network [Symbol, Increase::Models::CardPayment::Element::CardFuelConfirmation::Network] - # # @param network_identifiers [Increase::Models::CardPayment::Element::CardFuelConfirmation::NetworkIdentifiers] - # # @param pending_transaction_id [String, nil] - # # @param type [Symbol, Increase::Models::CardPayment::Element::CardFuelConfirmation::Type] - # # @param updated_authorization_amount [Integer] - # # - # def initialize( - # id:, - # card_authorization_id:, - # currency:, - # network:, - # network_identifiers:, - # pending_transaction_id:, - # type:, - # updated_authorization_amount:, - # ** - # ) - # super - # end - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(id:, card_authorization_id:, currency:, network:, network_identifiers:, pending_transaction_id:, type:, updated_authorization_amount:) + # A Card Fuel Confirmation object. This field will be present in the JSON response + # if and only if `category` is equal to `card_fuel_confirmation`. Card Fuel + # Confirmations update the amount of a Card Authorization after a fuel pump + # transaction is completed. + # + # @param id [String] + # @param card_authorization_id [String] + # @param currency [Symbol, Increase::Models::CardPayment::Element::CardFuelConfirmation::Currency] + # @param network [Symbol, Increase::Models::CardPayment::Element::CardFuelConfirmation::Network] + # @param network_identifiers [Increase::Models::CardPayment::Element::CardFuelConfirmation::NetworkIdentifiers] + # @param pending_transaction_id [String, nil] + # @param type [Symbol, Increase::Models::CardPayment::Element::CardFuelConfirmation::Type] + # @param updated_authorization_amount [Integer] # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the increment's # currency. @@ -2506,11 +2201,8 @@ module Currency # US Dollar (USD) USD = :USD - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # The card network used to process this card authorization. @@ -2522,11 +2214,8 @@ module Network # Visa VISA = :visa - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Increase::Models::CardPayment::Element::CardFuelConfirmation#network_identifiers @@ -2553,16 +2242,12 @@ class NetworkIdentifiers < Increase::Internal::Type::BaseModel # @return [String, nil] required :transaction_id, String, nil?: true - # @!parse - # # Network-specific identifiers for a specific request or transaction. - # # - # # @param retrieval_reference_number [String, nil] - # # @param trace_number [String, nil] - # # @param transaction_id [String, nil] - # # - # def initialize(retrieval_reference_number:, trace_number:, transaction_id:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(retrieval_reference_number:, trace_number:, transaction_id:) + # Network-specific identifiers for a specific request or transaction. + # + # @param retrieval_reference_number [String, nil] + # @param trace_number [String, nil] + # @param transaction_id [String, nil] end # A constant representing the object's type. For this resource it will always be @@ -2574,11 +2259,8 @@ module Type CARD_FUEL_CONFIRMATION = :card_fuel_confirmation - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -2664,43 +2346,23 @@ class CardIncrement < Increase::Internal::Type::BaseModel # @return [Integer] required :updated_authorization_amount, Integer - # @!parse - # # A Card Increment object. This field will be present in the JSON response if and - # # only if `category` is equal to `card_increment`. Card Increments increase the - # # pending amount of an authorized transaction. - # # - # # @param id [String] - # # @param actioner [Symbol, Increase::Models::CardPayment::Element::CardIncrement::Actioner] - # # @param amount [Integer] - # # @param card_authorization_id [String] - # # @param currency [Symbol, Increase::Models::CardPayment::Element::CardIncrement::Currency] - # # @param network [Symbol, Increase::Models::CardPayment::Element::CardIncrement::Network] - # # @param network_identifiers [Increase::Models::CardPayment::Element::CardIncrement::NetworkIdentifiers] - # # @param network_risk_score [Integer, nil] - # # @param pending_transaction_id [String, nil] - # # @param real_time_decision_id [String, nil] - # # @param type [Symbol, Increase::Models::CardPayment::Element::CardIncrement::Type] - # # @param updated_authorization_amount [Integer] - # # - # def initialize( - # id:, - # actioner:, - # amount:, - # card_authorization_id:, - # currency:, - # network:, - # network_identifiers:, - # network_risk_score:, - # pending_transaction_id:, - # real_time_decision_id:, - # type:, - # updated_authorization_amount:, - # ** - # ) - # super - # end - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(id:, actioner:, amount:, card_authorization_id:, currency:, network:, network_identifiers:, network_risk_score:, pending_transaction_id:, real_time_decision_id:, type:, updated_authorization_amount:) + # A Card Increment object. This field will be present in the JSON response if and + # only if `category` is equal to `card_increment`. Card Increments increase the + # pending amount of an authorized transaction. + # + # @param id [String] + # @param actioner [Symbol, Increase::Models::CardPayment::Element::CardIncrement::Actioner] + # @param amount [Integer] + # @param card_authorization_id [String] + # @param currency [Symbol, Increase::Models::CardPayment::Element::CardIncrement::Currency] + # @param network [Symbol, Increase::Models::CardPayment::Element::CardIncrement::Network] + # @param network_identifiers [Increase::Models::CardPayment::Element::CardIncrement::NetworkIdentifiers] + # @param network_risk_score [Integer, nil] + # @param pending_transaction_id [String, nil] + # @param real_time_decision_id [String, nil] + # @param type [Symbol, Increase::Models::CardPayment::Element::CardIncrement::Type] + # @param updated_authorization_amount [Integer] # Whether this authorization was approved by Increase, the card network through # stand-in processing, or the user through a real-time decision. @@ -2718,11 +2380,8 @@ module Actioner # This object was actioned by the network, through stand-in processing. NETWORK = :network - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the increment's @@ -2750,11 +2409,8 @@ module Currency # US Dollar (USD) USD = :USD - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # The card network used to process this card authorization. @@ -2766,11 +2422,8 @@ module Network # Visa VISA = :visa - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Increase::Models::CardPayment::Element::CardIncrement#network_identifiers @@ -2797,16 +2450,12 @@ class NetworkIdentifiers < Increase::Internal::Type::BaseModel # @return [String, nil] required :transaction_id, String, nil?: true - # @!parse - # # Network-specific identifiers for a specific request or transaction. - # # - # # @param retrieval_reference_number [String, nil] - # # @param trace_number [String, nil] - # # @param transaction_id [String, nil] - # # - # def initialize(retrieval_reference_number:, trace_number:, transaction_id:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(retrieval_reference_number:, trace_number:, transaction_id:) + # Network-specific identifiers for a specific request or transaction. + # + # @param retrieval_reference_number [String, nil] + # @param trace_number [String, nil] + # @param transaction_id [String, nil] end # A constant representing the object's type. For this resource it will always be @@ -2818,11 +2467,8 @@ module Type CARD_INCREMENT = :card_increment - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -2952,59 +2598,32 @@ class CardRefund < Increase::Internal::Type::BaseModel # @return [Symbol, Increase::Models::CardPayment::Element::CardRefund::Type] required :type, enum: -> { Increase::Models::CardPayment::Element::CardRefund::Type } - # @!parse - # # A Card Refund object. This field will be present in the JSON response if and - # # only if `category` is equal to `card_refund`. Card Refunds move money back to - # # the cardholder. While they are usually connected to a Card Settlement an - # # acquirer can also refund money directly to a card without relation to a - # # transaction. - # # - # # @param id [String] - # # @param amount [Integer] - # # @param card_payment_id [String] - # # @param cashback [Increase::Models::CardPayment::Element::CardRefund::Cashback, nil] - # # @param currency [Symbol, Increase::Models::CardPayment::Element::CardRefund::Currency] - # # @param interchange [Increase::Models::CardPayment::Element::CardRefund::Interchange, nil] - # # @param merchant_acceptor_id [String] - # # @param merchant_category_code [String] - # # @param merchant_city [String] - # # @param merchant_country [String] - # # @param merchant_name [String] - # # @param merchant_postal_code [String, nil] - # # @param merchant_state [String, nil] - # # @param network_identifiers [Increase::Models::CardPayment::Element::CardRefund::NetworkIdentifiers] - # # @param presentment_amount [Integer] - # # @param presentment_currency [String] - # # @param purchase_details [Increase::Models::CardPayment::Element::CardRefund::PurchaseDetails, nil] - # # @param transaction_id [String] - # # @param type [Symbol, Increase::Models::CardPayment::Element::CardRefund::Type] - # # - # def initialize( - # id:, - # amount:, - # card_payment_id:, - # cashback:, - # currency:, - # interchange:, - # merchant_acceptor_id:, - # merchant_category_code:, - # merchant_city:, - # merchant_country:, - # merchant_name:, - # merchant_postal_code:, - # merchant_state:, - # network_identifiers:, - # presentment_amount:, - # presentment_currency:, - # purchase_details:, - # transaction_id:, - # type:, - # ** - # ) - # super - # end - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(id:, amount:, card_payment_id:, cashback:, currency:, interchange:, merchant_acceptor_id:, merchant_category_code:, merchant_city:, merchant_country:, merchant_name:, merchant_postal_code:, merchant_state:, network_identifiers:, presentment_amount:, presentment_currency:, purchase_details:, transaction_id:, type:) + # A Card Refund object. This field will be present in the JSON response if and + # only if `category` is equal to `card_refund`. Card Refunds move money back to + # the cardholder. While they are usually connected to a Card Settlement an + # acquirer can also refund money directly to a card without relation to a + # transaction. + # + # @param id [String] + # @param amount [Integer] + # @param card_payment_id [String] + # @param cashback [Increase::Models::CardPayment::Element::CardRefund::Cashback, nil] + # @param currency [Symbol, Increase::Models::CardPayment::Element::CardRefund::Currency] + # @param interchange [Increase::Models::CardPayment::Element::CardRefund::Interchange, nil] + # @param merchant_acceptor_id [String] + # @param merchant_category_code [String] + # @param merchant_city [String] + # @param merchant_country [String] + # @param merchant_name [String] + # @param merchant_postal_code [String, nil] + # @param merchant_state [String, nil] + # @param network_identifiers [Increase::Models::CardPayment::Element::CardRefund::NetworkIdentifiers] + # @param presentment_amount [Integer] + # @param presentment_currency [String] + # @param purchase_details [Increase::Models::CardPayment::Element::CardRefund::PurchaseDetails, nil] + # @param transaction_id [String] + # @param type [Symbol, Increase::Models::CardPayment::Element::CardRefund::Type] # @see Increase::Models::CardPayment::Element::CardRefund#cashback class Cashback < Increase::Internal::Type::BaseModel @@ -3022,16 +2641,12 @@ class Cashback < Increase::Internal::Type::BaseModel # @return [Symbol, Increase::Models::CardPayment::Element::CardRefund::Cashback::Currency] required :currency, enum: -> { Increase::Models::CardPayment::Element::CardRefund::Cashback::Currency } - # @!parse - # # Cashback debited for this transaction, if eligible. Cashback is paid out in - # # aggregate, monthly. - # # - # # @param amount [String] - # # @param currency [Symbol, Increase::Models::CardPayment::Element::CardRefund::Cashback::Currency] - # # - # def initialize(amount:, currency:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(amount:, currency:) + # Cashback debited for this transaction, if eligible. Cashback is paid out in + # aggregate, monthly. + # + # @param amount [String] + # @param currency [Symbol, Increase::Models::CardPayment::Element::CardRefund::Cashback::Currency] # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the cashback. # @@ -3057,11 +2672,8 @@ module Currency # US Dollar (USD) USD = :USD - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -3090,11 +2702,8 @@ module Currency # US Dollar (USD) USD = :USD - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Increase::Models::CardPayment::Element::CardRefund#interchange @@ -3121,16 +2730,12 @@ class Interchange < Increase::Internal::Type::BaseModel # @return [Symbol, Increase::Models::CardPayment::Element::CardRefund::Interchange::Currency] required :currency, enum: -> { Increase::Models::CardPayment::Element::CardRefund::Interchange::Currency } - # @!parse - # # Interchange assessed as a part of this transaciton. - # # - # # @param amount [String] - # # @param code [String, nil] - # # @param currency [Symbol, Increase::Models::CardPayment::Element::CardRefund::Interchange::Currency] - # # - # def initialize(amount:, code:, currency:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(amount:, code:, currency:) + # Interchange assessed as a part of this transaciton. + # + # @param amount [String] + # @param code [String, nil] + # @param currency [Symbol, Increase::Models::CardPayment::Element::CardRefund::Interchange::Currency] # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the interchange # reimbursement. @@ -3157,11 +2762,8 @@ module Currency # US Dollar (USD) USD = :USD - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -3187,16 +2789,12 @@ class NetworkIdentifiers < Increase::Internal::Type::BaseModel # @return [String, nil] required :transaction_id, String, nil?: true - # @!parse - # # Network-specific identifiers for this refund. - # # - # # @param acquirer_business_id [String] - # # @param acquirer_reference_number [String] - # # @param transaction_id [String, nil] - # # - # def initialize(acquirer_business_id:, acquirer_reference_number:, transaction_id:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(acquirer_business_id:, acquirer_reference_number:, transaction_id:) + # Network-specific identifiers for this refund. + # + # @param acquirer_business_id [String] + # @param acquirer_reference_number [String] + # @param transaction_id [String, nil] end # @see Increase::Models::CardPayment::Element::CardRefund#purchase_details @@ -3271,38 +2869,20 @@ class PurchaseDetails < Increase::Internal::Type::BaseModel -> { Increase::Models::CardPayment::Element::CardRefund::PurchaseDetails::Travel }, nil?: true - # @!parse - # # Additional details about the card purchase, such as tax and industry-specific - # # fields. - # # - # # @param car_rental [Increase::Models::CardPayment::Element::CardRefund::PurchaseDetails::CarRental, nil] - # # @param customer_reference_identifier [String, nil] - # # @param local_tax_amount [Integer, nil] - # # @param local_tax_currency [String, nil] - # # @param lodging [Increase::Models::CardPayment::Element::CardRefund::PurchaseDetails::Lodging, nil] - # # @param national_tax_amount [Integer, nil] - # # @param national_tax_currency [String, nil] - # # @param purchase_identifier [String, nil] - # # @param purchase_identifier_format [Symbol, Increase::Models::CardPayment::Element::CardRefund::PurchaseDetails::PurchaseIdentifierFormat, nil] - # # @param travel [Increase::Models::CardPayment::Element::CardRefund::PurchaseDetails::Travel, nil] - # # - # def initialize( - # car_rental:, - # customer_reference_identifier:, - # local_tax_amount:, - # local_tax_currency:, - # lodging:, - # national_tax_amount:, - # national_tax_currency:, - # purchase_identifier:, - # purchase_identifier_format:, - # travel:, - # ** - # ) - # super - # end - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(car_rental:, customer_reference_identifier:, local_tax_amount:, local_tax_currency:, lodging:, national_tax_amount:, national_tax_currency:, purchase_identifier:, purchase_identifier_format:, travel:) + # Additional details about the card purchase, such as tax and industry-specific + # fields. + # + # @param car_rental [Increase::Models::CardPayment::Element::CardRefund::PurchaseDetails::CarRental, nil] + # @param customer_reference_identifier [String, nil] + # @param local_tax_amount [Integer, nil] + # @param local_tax_currency [String, nil] + # @param lodging [Increase::Models::CardPayment::Element::CardRefund::PurchaseDetails::Lodging, nil] + # @param national_tax_amount [Integer, nil] + # @param national_tax_currency [String, nil] + # @param purchase_identifier [String, nil] + # @param purchase_identifier_format [Symbol, Increase::Models::CardPayment::Element::CardRefund::PurchaseDetails::PurchaseIdentifierFormat, nil] + # @param travel [Increase::Models::CardPayment::Element::CardRefund::PurchaseDetails::Travel, nil] # @see Increase::Models::CardPayment::Element::CardRefund::PurchaseDetails#car_rental class CarRental < Increase::Internal::Type::BaseModel @@ -3414,49 +2994,25 @@ class CarRental < Increase::Internal::Type::BaseModel # @return [String, nil] required :weekly_rental_rate_currency, String, nil?: true - # @!parse - # # Fields specific to car rentals. - # # - # # @param car_class_code [String, nil] - # # @param checkout_date [Date, nil] - # # @param daily_rental_rate_amount [Integer, nil] - # # @param daily_rental_rate_currency [String, nil] - # # @param days_rented [Integer, nil] - # # @param extra_charges [Symbol, Increase::Models::CardPayment::Element::CardRefund::PurchaseDetails::CarRental::ExtraCharges, nil] - # # @param fuel_charges_amount [Integer, nil] - # # @param fuel_charges_currency [String, nil] - # # @param insurance_charges_amount [Integer, nil] - # # @param insurance_charges_currency [String, nil] - # # @param no_show_indicator [Symbol, Increase::Models::CardPayment::Element::CardRefund::PurchaseDetails::CarRental::NoShowIndicator, nil] - # # @param one_way_drop_off_charges_amount [Integer, nil] - # # @param one_way_drop_off_charges_currency [String, nil] - # # @param renter_name [String, nil] - # # @param weekly_rental_rate_amount [Integer, nil] - # # @param weekly_rental_rate_currency [String, nil] - # # - # def initialize( - # car_class_code:, - # checkout_date:, - # daily_rental_rate_amount:, - # daily_rental_rate_currency:, - # days_rented:, - # extra_charges:, - # fuel_charges_amount:, - # fuel_charges_currency:, - # insurance_charges_amount:, - # insurance_charges_currency:, - # no_show_indicator:, - # one_way_drop_off_charges_amount:, - # one_way_drop_off_charges_currency:, - # renter_name:, - # weekly_rental_rate_amount:, - # weekly_rental_rate_currency:, - # ** - # ) - # super - # end - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(car_class_code:, checkout_date:, daily_rental_rate_amount:, daily_rental_rate_currency:, days_rented:, extra_charges:, fuel_charges_amount:, fuel_charges_currency:, insurance_charges_amount:, insurance_charges_currency:, no_show_indicator:, one_way_drop_off_charges_amount:, one_way_drop_off_charges_currency:, renter_name:, weekly_rental_rate_amount:, weekly_rental_rate_currency:) + # Fields specific to car rentals. + # + # @param car_class_code [String, nil] + # @param checkout_date [Date, nil] + # @param daily_rental_rate_amount [Integer, nil] + # @param daily_rental_rate_currency [String, nil] + # @param days_rented [Integer, nil] + # @param extra_charges [Symbol, Increase::Models::CardPayment::Element::CardRefund::PurchaseDetails::CarRental::ExtraCharges, nil] + # @param fuel_charges_amount [Integer, nil] + # @param fuel_charges_currency [String, nil] + # @param insurance_charges_amount [Integer, nil] + # @param insurance_charges_currency [String, nil] + # @param no_show_indicator [Symbol, Increase::Models::CardPayment::Element::CardRefund::PurchaseDetails::CarRental::NoShowIndicator, nil] + # @param one_way_drop_off_charges_amount [Integer, nil] + # @param one_way_drop_off_charges_currency [String, nil] + # @param renter_name [String, nil] + # @param weekly_rental_rate_amount [Integer, nil] + # @param weekly_rental_rate_currency [String, nil] # Additional charges (gas, late fee, etc.) being billed. # @@ -3482,11 +3038,8 @@ module ExtraCharges # Parking violation PARKING_VIOLATION = :parking_violation - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # An indicator that the cardholder is being billed for a reserved vehicle that was @@ -3502,11 +3055,8 @@ module NoShowIndicator # No show for specialized vehicle NO_SHOW_FOR_SPECIALIZED_VEHICLE = :no_show_for_specialized_vehicle - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -3619,49 +3169,25 @@ class Lodging < Increase::Internal::Type::BaseModel # @return [String, nil] required :total_tax_currency, String, nil?: true - # @!parse - # # Fields specific to lodging. - # # - # # @param check_in_date [Date, nil] - # # @param daily_room_rate_amount [Integer, nil] - # # @param daily_room_rate_currency [String, nil] - # # @param extra_charges [Symbol, Increase::Models::CardPayment::Element::CardRefund::PurchaseDetails::Lodging::ExtraCharges, nil] - # # @param folio_cash_advances_amount [Integer, nil] - # # @param folio_cash_advances_currency [String, nil] - # # @param food_beverage_charges_amount [Integer, nil] - # # @param food_beverage_charges_currency [String, nil] - # # @param no_show_indicator [Symbol, Increase::Models::CardPayment::Element::CardRefund::PurchaseDetails::Lodging::NoShowIndicator, nil] - # # @param prepaid_expenses_amount [Integer, nil] - # # @param prepaid_expenses_currency [String, nil] - # # @param room_nights [Integer, nil] - # # @param total_room_tax_amount [Integer, nil] - # # @param total_room_tax_currency [String, nil] - # # @param total_tax_amount [Integer, nil] - # # @param total_tax_currency [String, nil] - # # - # def initialize( - # check_in_date:, - # daily_room_rate_amount:, - # daily_room_rate_currency:, - # extra_charges:, - # folio_cash_advances_amount:, - # folio_cash_advances_currency:, - # food_beverage_charges_amount:, - # food_beverage_charges_currency:, - # no_show_indicator:, - # prepaid_expenses_amount:, - # prepaid_expenses_currency:, - # room_nights:, - # total_room_tax_amount:, - # total_room_tax_currency:, - # total_tax_amount:, - # total_tax_currency:, - # ** - # ) - # super - # end - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(check_in_date:, daily_room_rate_amount:, daily_room_rate_currency:, extra_charges:, folio_cash_advances_amount:, folio_cash_advances_currency:, food_beverage_charges_amount:, food_beverage_charges_currency:, no_show_indicator:, prepaid_expenses_amount:, prepaid_expenses_currency:, room_nights:, total_room_tax_amount:, total_room_tax_currency:, total_tax_amount:, total_tax_currency:) + # Fields specific to lodging. + # + # @param check_in_date [Date, nil] + # @param daily_room_rate_amount [Integer, nil] + # @param daily_room_rate_currency [String, nil] + # @param extra_charges [Symbol, Increase::Models::CardPayment::Element::CardRefund::PurchaseDetails::Lodging::ExtraCharges, nil] + # @param folio_cash_advances_amount [Integer, nil] + # @param folio_cash_advances_currency [String, nil] + # @param food_beverage_charges_amount [Integer, nil] + # @param food_beverage_charges_currency [String, nil] + # @param no_show_indicator [Symbol, Increase::Models::CardPayment::Element::CardRefund::PurchaseDetails::Lodging::NoShowIndicator, nil] + # @param prepaid_expenses_amount [Integer, nil] + # @param prepaid_expenses_currency [String, nil] + # @param room_nights [Integer, nil] + # @param total_room_tax_amount [Integer, nil] + # @param total_room_tax_currency [String, nil] + # @param total_tax_amount [Integer, nil] + # @param total_tax_currency [String, nil] # Additional charges (phone, late check-out, etc.) being billed. # @@ -3690,11 +3216,8 @@ module ExtraCharges # Laundry LAUNDRY = :laundry - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # Indicator that the cardholder is being billed for a reserved room that was not @@ -3710,11 +3233,8 @@ module NoShowIndicator # No show NO_SHOW = :no_show - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -3739,11 +3259,8 @@ module PurchaseIdentifierFormat # Invoice number INVOICE_NUMBER = :invoice_number - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Increase::Models::CardPayment::Element::CardRefund::PurchaseDetails#travel @@ -3830,41 +3347,21 @@ class Travel < Increase::Internal::Type::BaseModel -> { Increase::Internal::Type::ArrayOf[Increase::Models::CardPayment::Element::CardRefund::PurchaseDetails::Travel::TripLeg] }, nil?: true - # @!parse - # # Fields specific to travel. - # # - # # @param ancillary [Increase::Models::CardPayment::Element::CardRefund::PurchaseDetails::Travel::Ancillary, nil] - # # @param computerized_reservation_system [String, nil] - # # @param credit_reason_indicator [Symbol, Increase::Models::CardPayment::Element::CardRefund::PurchaseDetails::Travel::CreditReasonIndicator, nil] - # # @param departure_date [Date, nil] - # # @param origination_city_airport_code [String, nil] - # # @param passenger_name [String, nil] - # # @param restricted_ticket_indicator [Symbol, Increase::Models::CardPayment::Element::CardRefund::PurchaseDetails::Travel::RestrictedTicketIndicator, nil] - # # @param ticket_change_indicator [Symbol, Increase::Models::CardPayment::Element::CardRefund::PurchaseDetails::Travel::TicketChangeIndicator, nil] - # # @param ticket_number [String, nil] - # # @param travel_agency_code [String, nil] - # # @param travel_agency_name [String, nil] - # # @param trip_legs [Array, nil] - # # - # def initialize( - # ancillary:, - # computerized_reservation_system:, - # credit_reason_indicator:, - # departure_date:, - # origination_city_airport_code:, - # passenger_name:, - # restricted_ticket_indicator:, - # ticket_change_indicator:, - # ticket_number:, - # travel_agency_code:, - # travel_agency_name:, - # trip_legs:, - # ** - # ) - # super - # end - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(ancillary:, computerized_reservation_system:, credit_reason_indicator:, departure_date:, origination_city_airport_code:, passenger_name:, restricted_ticket_indicator:, ticket_change_indicator:, ticket_number:, travel_agency_code:, travel_agency_name:, trip_legs:) + # Fields specific to travel. + # + # @param ancillary [Increase::Models::CardPayment::Element::CardRefund::PurchaseDetails::Travel::Ancillary, nil] + # @param computerized_reservation_system [String, nil] + # @param credit_reason_indicator [Symbol, Increase::Models::CardPayment::Element::CardRefund::PurchaseDetails::Travel::CreditReasonIndicator, nil] + # @param departure_date [Date, nil] + # @param origination_city_airport_code [String, nil] + # @param passenger_name [String, nil] + # @param restricted_ticket_indicator [Symbol, Increase::Models::CardPayment::Element::CardRefund::PurchaseDetails::Travel::RestrictedTicketIndicator, nil] + # @param ticket_change_indicator [Symbol, Increase::Models::CardPayment::Element::CardRefund::PurchaseDetails::Travel::TicketChangeIndicator, nil] + # @param ticket_number [String, nil] + # @param travel_agency_code [String, nil] + # @param travel_agency_name [String, nil] + # @param trip_legs [Array, nil] # @see Increase::Models::CardPayment::Element::CardRefund::PurchaseDetails::Travel#ancillary class Ancillary < Increase::Internal::Type::BaseModel @@ -3903,27 +3400,14 @@ class Ancillary < Increase::Internal::Type::BaseModel # @return [String, nil] required :ticket_document_number, String, nil?: true - # @!parse - # # Ancillary purchases in addition to the airfare. - # # - # # @param connected_ticket_document_number [String, nil] - # # @param credit_reason_indicator [Symbol, Increase::Models::CardPayment::Element::CardRefund::PurchaseDetails::Travel::Ancillary::CreditReasonIndicator, nil] - # # @param passenger_name_or_description [String, nil] - # # @param services [Array] - # # @param ticket_document_number [String, nil] - # # - # def initialize( - # connected_ticket_document_number:, - # credit_reason_indicator:, - # passenger_name_or_description:, - # services:, - # ticket_document_number:, - # ** - # ) - # super - # end - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(connected_ticket_document_number:, credit_reason_indicator:, passenger_name_or_description:, services:, ticket_document_number:) + # Ancillary purchases in addition to the airfare. + # + # @param connected_ticket_document_number [String, nil] + # @param credit_reason_indicator [Symbol, Increase::Models::CardPayment::Element::CardRefund::PurchaseDetails::Travel::Ancillary::CreditReasonIndicator, nil] + # @param passenger_name_or_description [String, nil] + # @param services [Array] + # @param ticket_document_number [String, nil] # Indicates the reason for a credit to the cardholder. # @@ -3945,11 +3429,8 @@ module CreditReasonIndicator # Other OTHER = :other - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end class Service < Increase::Internal::Type::BaseModel @@ -3967,13 +3448,9 @@ class Service < Increase::Internal::Type::BaseModel # @return [String, nil] required :sub_category, String, nil?: true - # @!parse - # # @param category [Symbol, Increase::Models::CardPayment::Element::CardRefund::PurchaseDetails::Travel::Ancillary::Service::Category, nil] - # # @param sub_category [String, nil] - # # - # def initialize(category:, sub_category:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(category:, sub_category:) + # @param category [Symbol, Increase::Models::CardPayment::Element::CardRefund::PurchaseDetails::Travel::Ancillary::Service::Category, nil] + # @param sub_category [String, nil] # Category of the ancillary service. # @@ -4053,11 +3530,8 @@ module Category # Wi-fi WIFI = :wifi - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -4088,11 +3562,8 @@ module CreditReasonIndicator # Partial refund of airline ticket PARTIAL_REFUND_OF_AIRLINE_TICKET = :partial_refund_of_airline_ticket - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # Indicates whether this ticket is non-refundable. @@ -4107,11 +3578,8 @@ module RestrictedTicketIndicator # Restricted non-refundable ticket RESTRICTED_NON_REFUNDABLE_TICKET = :restricted_non_refundable_ticket - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # Indicates why a ticket was changed. @@ -4129,11 +3597,8 @@ module TicketChangeIndicator # New ticket NEW_TICKET = :new_ticket - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end class TripLeg < Increase::Internal::Type::BaseModel @@ -4175,27 +3640,13 @@ class TripLeg < Increase::Internal::Type::BaseModel enum: -> { Increase::Models::CardPayment::Element::CardRefund::PurchaseDetails::Travel::TripLeg::StopOverCode }, nil?: true - # @!parse - # # @param carrier_code [String, nil] - # # @param destination_city_airport_code [String, nil] - # # @param fare_basis_code [String, nil] - # # @param flight_number [String, nil] - # # @param service_class [String, nil] - # # @param stop_over_code [Symbol, Increase::Models::CardPayment::Element::CardRefund::PurchaseDetails::Travel::TripLeg::StopOverCode, nil] - # # - # def initialize( - # carrier_code:, - # destination_city_airport_code:, - # fare_basis_code:, - # flight_number:, - # service_class:, - # stop_over_code:, - # ** - # ) - # super - # end - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(carrier_code:, destination_city_airport_code:, fare_basis_code:, flight_number:, service_class:, stop_over_code:) + # @param carrier_code [String, nil] + # @param destination_city_airport_code [String, nil] + # @param fare_basis_code [String, nil] + # @param flight_number [String, nil] + # @param service_class [String, nil] + # @param stop_over_code [Symbol, Increase::Models::CardPayment::Element::CardRefund::PurchaseDetails::Travel::TripLeg::StopOverCode, nil] # Indicates whether a stopover is allowed on this ticket. # @@ -4212,11 +3663,8 @@ module StopOverCode # Stop over not allowed STOP_OVER_NOT_ALLOWED = :stop_over_not_allowed - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -4231,11 +3679,8 @@ module Type CARD_REFUND = :card_refund - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -4360,55 +3805,29 @@ class CardReversal < Increase::Internal::Type::BaseModel # @return [Integer] required :updated_authorization_amount, Integer - # @!parse - # # A Card Reversal object. This field will be present in the JSON response if and - # # only if `category` is equal to `card_reversal`. Card Reversals cancel parts of - # # or the entirety of an existing Card Authorization. - # # - # # @param id [String] - # # @param card_authorization_id [String] - # # @param currency [Symbol, Increase::Models::CardPayment::Element::CardReversal::Currency] - # # @param merchant_acceptor_id [String] - # # @param merchant_category_code [String] - # # @param merchant_city [String, nil] - # # @param merchant_country [String, nil] - # # @param merchant_descriptor [String] - # # @param merchant_postal_code [String, nil] - # # @param merchant_state [String, nil] - # # @param network [Symbol, Increase::Models::CardPayment::Element::CardReversal::Network] - # # @param network_identifiers [Increase::Models::CardPayment::Element::CardReversal::NetworkIdentifiers] - # # @param pending_transaction_id [String, nil] - # # @param reversal_amount [Integer] - # # @param reversal_reason [Symbol, Increase::Models::CardPayment::Element::CardReversal::ReversalReason, nil] - # # @param terminal_id [String, nil] - # # @param type [Symbol, Increase::Models::CardPayment::Element::CardReversal::Type] - # # @param updated_authorization_amount [Integer] - # # - # def initialize( - # id:, - # card_authorization_id:, - # currency:, - # merchant_acceptor_id:, - # merchant_category_code:, - # merchant_city:, - # merchant_country:, - # merchant_descriptor:, - # merchant_postal_code:, - # merchant_state:, - # network:, - # network_identifiers:, - # pending_transaction_id:, - # reversal_amount:, - # reversal_reason:, - # terminal_id:, - # type:, - # updated_authorization_amount:, - # ** - # ) - # super - # end - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(id:, card_authorization_id:, currency:, merchant_acceptor_id:, merchant_category_code:, merchant_city:, merchant_country:, merchant_descriptor:, merchant_postal_code:, merchant_state:, network:, network_identifiers:, pending_transaction_id:, reversal_amount:, reversal_reason:, terminal_id:, type:, updated_authorization_amount:) + # A Card Reversal object. This field will be present in the JSON response if and + # only if `category` is equal to `card_reversal`. Card Reversals cancel parts of + # or the entirety of an existing Card Authorization. + # + # @param id [String] + # @param card_authorization_id [String] + # @param currency [Symbol, Increase::Models::CardPayment::Element::CardReversal::Currency] + # @param merchant_acceptor_id [String] + # @param merchant_category_code [String] + # @param merchant_city [String, nil] + # @param merchant_country [String, nil] + # @param merchant_descriptor [String] + # @param merchant_postal_code [String, nil] + # @param merchant_state [String, nil] + # @param network [Symbol, Increase::Models::CardPayment::Element::CardReversal::Network] + # @param network_identifiers [Increase::Models::CardPayment::Element::CardReversal::NetworkIdentifiers] + # @param pending_transaction_id [String, nil] + # @param reversal_amount [Integer] + # @param reversal_reason [Symbol, Increase::Models::CardPayment::Element::CardReversal::ReversalReason, nil] + # @param terminal_id [String, nil] + # @param type [Symbol, Increase::Models::CardPayment::Element::CardReversal::Type] + # @param updated_authorization_amount [Integer] # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the reversal's # currency. @@ -4435,11 +3854,8 @@ module Currency # US Dollar (USD) USD = :USD - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # The card network used to process this card authorization. @@ -4451,11 +3867,8 @@ module Network # Visa VISA = :visa - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Increase::Models::CardPayment::Element::CardReversal#network_identifiers @@ -4482,16 +3895,12 @@ class NetworkIdentifiers < Increase::Internal::Type::BaseModel # @return [String, nil] required :transaction_id, String, nil?: true - # @!parse - # # Network-specific identifiers for a specific request or transaction. - # # - # # @param retrieval_reference_number [String, nil] - # # @param trace_number [String, nil] - # # @param transaction_id [String, nil] - # # - # def initialize(retrieval_reference_number:, trace_number:, transaction_id:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(retrieval_reference_number:, trace_number:, transaction_id:) + # Network-specific identifiers for a specific request or transaction. + # + # @param retrieval_reference_number [String, nil] + # @param trace_number [String, nil] + # @param transaction_id [String, nil] end # Why this reversal was initiated. @@ -4512,11 +3921,8 @@ module ReversalReason # The Card Reversal was a partial reversal, for any reason. PARTIAL_REVERSAL = :partial_reversal - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # A constant representing the object's type. For this resource it will always be @@ -4528,11 +3934,8 @@ module Type CARD_REVERSAL = :card_reversal - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -4677,63 +4080,34 @@ class CardSettlement < Increase::Internal::Type::BaseModel # @return [Symbol, Increase::Models::CardPayment::Element::CardSettlement::Type] required :type, enum: -> { Increase::Models::CardPayment::Element::CardSettlement::Type } - # @!parse - # # A Card Settlement object. This field will be present in the JSON response if and - # # only if `category` is equal to `card_settlement`. Card Settlements are card - # # transactions that have cleared and settled. While a settlement is usually - # # preceded by an authorization, an acquirer can also directly clear a transaction - # # without first authorizing it. - # # - # # @param id [String] - # # @param amount [Integer] - # # @param card_authorization [String, nil] - # # @param card_payment_id [String] - # # @param cashback [Increase::Models::CardPayment::Element::CardSettlement::Cashback, nil] - # # @param currency [Symbol, Increase::Models::CardPayment::Element::CardSettlement::Currency] - # # @param interchange [Increase::Models::CardPayment::Element::CardSettlement::Interchange, nil] - # # @param merchant_acceptor_id [String] - # # @param merchant_category_code [String] - # # @param merchant_city [String] - # # @param merchant_country [String] - # # @param merchant_name [String] - # # @param merchant_postal_code [String, nil] - # # @param merchant_state [String, nil] - # # @param network_identifiers [Increase::Models::CardPayment::Element::CardSettlement::NetworkIdentifiers] - # # @param pending_transaction_id [String, nil] - # # @param presentment_amount [Integer] - # # @param presentment_currency [String] - # # @param purchase_details [Increase::Models::CardPayment::Element::CardSettlement::PurchaseDetails, nil] - # # @param transaction_id [String] - # # @param type [Symbol, Increase::Models::CardPayment::Element::CardSettlement::Type] - # # - # def initialize( - # id:, - # amount:, - # card_authorization:, - # card_payment_id:, - # cashback:, - # currency:, - # interchange:, - # merchant_acceptor_id:, - # merchant_category_code:, - # merchant_city:, - # merchant_country:, - # merchant_name:, - # merchant_postal_code:, - # merchant_state:, - # network_identifiers:, - # pending_transaction_id:, - # presentment_amount:, - # presentment_currency:, - # purchase_details:, - # transaction_id:, - # type:, - # ** - # ) - # super - # end - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(id:, amount:, card_authorization:, card_payment_id:, cashback:, currency:, interchange:, merchant_acceptor_id:, merchant_category_code:, merchant_city:, merchant_country:, merchant_name:, merchant_postal_code:, merchant_state:, network_identifiers:, pending_transaction_id:, presentment_amount:, presentment_currency:, purchase_details:, transaction_id:, type:) + # A Card Settlement object. This field will be present in the JSON response if and + # only if `category` is equal to `card_settlement`. Card Settlements are card + # transactions that have cleared and settled. While a settlement is usually + # preceded by an authorization, an acquirer can also directly clear a transaction + # without first authorizing it. + # + # @param id [String] + # @param amount [Integer] + # @param card_authorization [String, nil] + # @param card_payment_id [String] + # @param cashback [Increase::Models::CardPayment::Element::CardSettlement::Cashback, nil] + # @param currency [Symbol, Increase::Models::CardPayment::Element::CardSettlement::Currency] + # @param interchange [Increase::Models::CardPayment::Element::CardSettlement::Interchange, nil] + # @param merchant_acceptor_id [String] + # @param merchant_category_code [String] + # @param merchant_city [String] + # @param merchant_country [String] + # @param merchant_name [String] + # @param merchant_postal_code [String, nil] + # @param merchant_state [String, nil] + # @param network_identifiers [Increase::Models::CardPayment::Element::CardSettlement::NetworkIdentifiers] + # @param pending_transaction_id [String, nil] + # @param presentment_amount [Integer] + # @param presentment_currency [String] + # @param purchase_details [Increase::Models::CardPayment::Element::CardSettlement::PurchaseDetails, nil] + # @param transaction_id [String] + # @param type [Symbol, Increase::Models::CardPayment::Element::CardSettlement::Type] # @see Increase::Models::CardPayment::Element::CardSettlement#cashback class Cashback < Increase::Internal::Type::BaseModel @@ -4752,16 +4126,12 @@ class Cashback < Increase::Internal::Type::BaseModel required :currency, enum: -> { Increase::Models::CardPayment::Element::CardSettlement::Cashback::Currency } - # @!parse - # # Cashback earned on this transaction, if eligible. Cashback is paid out in - # # aggregate, monthly. - # # - # # @param amount [String] - # # @param currency [Symbol, Increase::Models::CardPayment::Element::CardSettlement::Cashback::Currency] - # # - # def initialize(amount:, currency:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(amount:, currency:) + # Cashback earned on this transaction, if eligible. Cashback is paid out in + # aggregate, monthly. + # + # @param amount [String] + # @param currency [Symbol, Increase::Models::CardPayment::Element::CardSettlement::Cashback::Currency] # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the cashback. # @@ -4787,11 +4157,8 @@ module Currency # US Dollar (USD) USD = :USD - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -4820,11 +4187,8 @@ module Currency # US Dollar (USD) USD = :USD - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Increase::Models::CardPayment::Element::CardSettlement#interchange @@ -4852,16 +4216,12 @@ class Interchange < Increase::Internal::Type::BaseModel required :currency, enum: -> { Increase::Models::CardPayment::Element::CardSettlement::Interchange::Currency } - # @!parse - # # Interchange assessed as a part of this transaction. - # # - # # @param amount [String] - # # @param code [String, nil] - # # @param currency [Symbol, Increase::Models::CardPayment::Element::CardSettlement::Interchange::Currency] - # # - # def initialize(amount:, code:, currency:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(amount:, code:, currency:) + # Interchange assessed as a part of this transaction. + # + # @param amount [String] + # @param code [String, nil] + # @param currency [Symbol, Increase::Models::CardPayment::Element::CardSettlement::Interchange::Currency] # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the interchange # reimbursement. @@ -4888,11 +4248,8 @@ module Currency # US Dollar (USD) USD = :USD - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -4918,16 +4275,12 @@ class NetworkIdentifiers < Increase::Internal::Type::BaseModel # @return [String, nil] required :transaction_id, String, nil?: true - # @!parse - # # Network-specific identifiers for this refund. - # # - # # @param acquirer_business_id [String] - # # @param acquirer_reference_number [String] - # # @param transaction_id [String, nil] - # # - # def initialize(acquirer_business_id:, acquirer_reference_number:, transaction_id:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(acquirer_business_id:, acquirer_reference_number:, transaction_id:) + # Network-specific identifiers for this refund. + # + # @param acquirer_business_id [String] + # @param acquirer_reference_number [String] + # @param transaction_id [String, nil] end # @see Increase::Models::CardPayment::Element::CardSettlement#purchase_details @@ -5002,38 +4355,20 @@ class PurchaseDetails < Increase::Internal::Type::BaseModel -> { Increase::Models::CardPayment::Element::CardSettlement::PurchaseDetails::Travel }, nil?: true - # @!parse - # # Additional details about the card purchase, such as tax and industry-specific - # # fields. - # # - # # @param car_rental [Increase::Models::CardPayment::Element::CardSettlement::PurchaseDetails::CarRental, nil] - # # @param customer_reference_identifier [String, nil] - # # @param local_tax_amount [Integer, nil] - # # @param local_tax_currency [String, nil] - # # @param lodging [Increase::Models::CardPayment::Element::CardSettlement::PurchaseDetails::Lodging, nil] - # # @param national_tax_amount [Integer, nil] - # # @param national_tax_currency [String, nil] - # # @param purchase_identifier [String, nil] - # # @param purchase_identifier_format [Symbol, Increase::Models::CardPayment::Element::CardSettlement::PurchaseDetails::PurchaseIdentifierFormat, nil] - # # @param travel [Increase::Models::CardPayment::Element::CardSettlement::PurchaseDetails::Travel, nil] - # # - # def initialize( - # car_rental:, - # customer_reference_identifier:, - # local_tax_amount:, - # local_tax_currency:, - # lodging:, - # national_tax_amount:, - # national_tax_currency:, - # purchase_identifier:, - # purchase_identifier_format:, - # travel:, - # ** - # ) - # super - # end - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(car_rental:, customer_reference_identifier:, local_tax_amount:, local_tax_currency:, lodging:, national_tax_amount:, national_tax_currency:, purchase_identifier:, purchase_identifier_format:, travel:) + # Additional details about the card purchase, such as tax and industry-specific + # fields. + # + # @param car_rental [Increase::Models::CardPayment::Element::CardSettlement::PurchaseDetails::CarRental, nil] + # @param customer_reference_identifier [String, nil] + # @param local_tax_amount [Integer, nil] + # @param local_tax_currency [String, nil] + # @param lodging [Increase::Models::CardPayment::Element::CardSettlement::PurchaseDetails::Lodging, nil] + # @param national_tax_amount [Integer, nil] + # @param national_tax_currency [String, nil] + # @param purchase_identifier [String, nil] + # @param purchase_identifier_format [Symbol, Increase::Models::CardPayment::Element::CardSettlement::PurchaseDetails::PurchaseIdentifierFormat, nil] + # @param travel [Increase::Models::CardPayment::Element::CardSettlement::PurchaseDetails::Travel, nil] # @see Increase::Models::CardPayment::Element::CardSettlement::PurchaseDetails#car_rental class CarRental < Increase::Internal::Type::BaseModel @@ -5145,49 +4480,25 @@ class CarRental < Increase::Internal::Type::BaseModel # @return [String, nil] required :weekly_rental_rate_currency, String, nil?: true - # @!parse - # # Fields specific to car rentals. - # # - # # @param car_class_code [String, nil] - # # @param checkout_date [Date, nil] - # # @param daily_rental_rate_amount [Integer, nil] - # # @param daily_rental_rate_currency [String, nil] - # # @param days_rented [Integer, nil] - # # @param extra_charges [Symbol, Increase::Models::CardPayment::Element::CardSettlement::PurchaseDetails::CarRental::ExtraCharges, nil] - # # @param fuel_charges_amount [Integer, nil] - # # @param fuel_charges_currency [String, nil] - # # @param insurance_charges_amount [Integer, nil] - # # @param insurance_charges_currency [String, nil] - # # @param no_show_indicator [Symbol, Increase::Models::CardPayment::Element::CardSettlement::PurchaseDetails::CarRental::NoShowIndicator, nil] - # # @param one_way_drop_off_charges_amount [Integer, nil] - # # @param one_way_drop_off_charges_currency [String, nil] - # # @param renter_name [String, nil] - # # @param weekly_rental_rate_amount [Integer, nil] - # # @param weekly_rental_rate_currency [String, nil] - # # - # def initialize( - # car_class_code:, - # checkout_date:, - # daily_rental_rate_amount:, - # daily_rental_rate_currency:, - # days_rented:, - # extra_charges:, - # fuel_charges_amount:, - # fuel_charges_currency:, - # insurance_charges_amount:, - # insurance_charges_currency:, - # no_show_indicator:, - # one_way_drop_off_charges_amount:, - # one_way_drop_off_charges_currency:, - # renter_name:, - # weekly_rental_rate_amount:, - # weekly_rental_rate_currency:, - # ** - # ) - # super - # end - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(car_class_code:, checkout_date:, daily_rental_rate_amount:, daily_rental_rate_currency:, days_rented:, extra_charges:, fuel_charges_amount:, fuel_charges_currency:, insurance_charges_amount:, insurance_charges_currency:, no_show_indicator:, one_way_drop_off_charges_amount:, one_way_drop_off_charges_currency:, renter_name:, weekly_rental_rate_amount:, weekly_rental_rate_currency:) + # Fields specific to car rentals. + # + # @param car_class_code [String, nil] + # @param checkout_date [Date, nil] + # @param daily_rental_rate_amount [Integer, nil] + # @param daily_rental_rate_currency [String, nil] + # @param days_rented [Integer, nil] + # @param extra_charges [Symbol, Increase::Models::CardPayment::Element::CardSettlement::PurchaseDetails::CarRental::ExtraCharges, nil] + # @param fuel_charges_amount [Integer, nil] + # @param fuel_charges_currency [String, nil] + # @param insurance_charges_amount [Integer, nil] + # @param insurance_charges_currency [String, nil] + # @param no_show_indicator [Symbol, Increase::Models::CardPayment::Element::CardSettlement::PurchaseDetails::CarRental::NoShowIndicator, nil] + # @param one_way_drop_off_charges_amount [Integer, nil] + # @param one_way_drop_off_charges_currency [String, nil] + # @param renter_name [String, nil] + # @param weekly_rental_rate_amount [Integer, nil] + # @param weekly_rental_rate_currency [String, nil] # Additional charges (gas, late fee, etc.) being billed. # @@ -5213,11 +4524,8 @@ module ExtraCharges # Parking violation PARKING_VIOLATION = :parking_violation - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # An indicator that the cardholder is being billed for a reserved vehicle that was @@ -5233,11 +4541,8 @@ module NoShowIndicator # No show for specialized vehicle NO_SHOW_FOR_SPECIALIZED_VEHICLE = :no_show_for_specialized_vehicle - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -5350,49 +4655,25 @@ class Lodging < Increase::Internal::Type::BaseModel # @return [String, nil] required :total_tax_currency, String, nil?: true - # @!parse - # # Fields specific to lodging. - # # - # # @param check_in_date [Date, nil] - # # @param daily_room_rate_amount [Integer, nil] - # # @param daily_room_rate_currency [String, nil] - # # @param extra_charges [Symbol, Increase::Models::CardPayment::Element::CardSettlement::PurchaseDetails::Lodging::ExtraCharges, nil] - # # @param folio_cash_advances_amount [Integer, nil] - # # @param folio_cash_advances_currency [String, nil] - # # @param food_beverage_charges_amount [Integer, nil] - # # @param food_beverage_charges_currency [String, nil] - # # @param no_show_indicator [Symbol, Increase::Models::CardPayment::Element::CardSettlement::PurchaseDetails::Lodging::NoShowIndicator, nil] - # # @param prepaid_expenses_amount [Integer, nil] - # # @param prepaid_expenses_currency [String, nil] - # # @param room_nights [Integer, nil] - # # @param total_room_tax_amount [Integer, nil] - # # @param total_room_tax_currency [String, nil] - # # @param total_tax_amount [Integer, nil] - # # @param total_tax_currency [String, nil] - # # - # def initialize( - # check_in_date:, - # daily_room_rate_amount:, - # daily_room_rate_currency:, - # extra_charges:, - # folio_cash_advances_amount:, - # folio_cash_advances_currency:, - # food_beverage_charges_amount:, - # food_beverage_charges_currency:, - # no_show_indicator:, - # prepaid_expenses_amount:, - # prepaid_expenses_currency:, - # room_nights:, - # total_room_tax_amount:, - # total_room_tax_currency:, - # total_tax_amount:, - # total_tax_currency:, - # ** - # ) - # super - # end - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(check_in_date:, daily_room_rate_amount:, daily_room_rate_currency:, extra_charges:, folio_cash_advances_amount:, folio_cash_advances_currency:, food_beverage_charges_amount:, food_beverage_charges_currency:, no_show_indicator:, prepaid_expenses_amount:, prepaid_expenses_currency:, room_nights:, total_room_tax_amount:, total_room_tax_currency:, total_tax_amount:, total_tax_currency:) + # Fields specific to lodging. + # + # @param check_in_date [Date, nil] + # @param daily_room_rate_amount [Integer, nil] + # @param daily_room_rate_currency [String, nil] + # @param extra_charges [Symbol, Increase::Models::CardPayment::Element::CardSettlement::PurchaseDetails::Lodging::ExtraCharges, nil] + # @param folio_cash_advances_amount [Integer, nil] + # @param folio_cash_advances_currency [String, nil] + # @param food_beverage_charges_amount [Integer, nil] + # @param food_beverage_charges_currency [String, nil] + # @param no_show_indicator [Symbol, Increase::Models::CardPayment::Element::CardSettlement::PurchaseDetails::Lodging::NoShowIndicator, nil] + # @param prepaid_expenses_amount [Integer, nil] + # @param prepaid_expenses_currency [String, nil] + # @param room_nights [Integer, nil] + # @param total_room_tax_amount [Integer, nil] + # @param total_room_tax_currency [String, nil] + # @param total_tax_amount [Integer, nil] + # @param total_tax_currency [String, nil] # Additional charges (phone, late check-out, etc.) being billed. # @@ -5421,11 +4702,8 @@ module ExtraCharges # Laundry LAUNDRY = :laundry - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # Indicator that the cardholder is being billed for a reserved room that was not @@ -5441,11 +4719,8 @@ module NoShowIndicator # No show NO_SHOW = :no_show - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -5470,11 +4745,8 @@ module PurchaseIdentifierFormat # Invoice number INVOICE_NUMBER = :invoice_number - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Increase::Models::CardPayment::Element::CardSettlement::PurchaseDetails#travel @@ -5561,41 +4833,21 @@ class Travel < Increase::Internal::Type::BaseModel -> { Increase::Internal::Type::ArrayOf[Increase::Models::CardPayment::Element::CardSettlement::PurchaseDetails::Travel::TripLeg] }, nil?: true - # @!parse - # # Fields specific to travel. - # # - # # @param ancillary [Increase::Models::CardPayment::Element::CardSettlement::PurchaseDetails::Travel::Ancillary, nil] - # # @param computerized_reservation_system [String, nil] - # # @param credit_reason_indicator [Symbol, Increase::Models::CardPayment::Element::CardSettlement::PurchaseDetails::Travel::CreditReasonIndicator, nil] - # # @param departure_date [Date, nil] - # # @param origination_city_airport_code [String, nil] - # # @param passenger_name [String, nil] - # # @param restricted_ticket_indicator [Symbol, Increase::Models::CardPayment::Element::CardSettlement::PurchaseDetails::Travel::RestrictedTicketIndicator, nil] - # # @param ticket_change_indicator [Symbol, Increase::Models::CardPayment::Element::CardSettlement::PurchaseDetails::Travel::TicketChangeIndicator, nil] - # # @param ticket_number [String, nil] - # # @param travel_agency_code [String, nil] - # # @param travel_agency_name [String, nil] - # # @param trip_legs [Array, nil] - # # - # def initialize( - # ancillary:, - # computerized_reservation_system:, - # credit_reason_indicator:, - # departure_date:, - # origination_city_airport_code:, - # passenger_name:, - # restricted_ticket_indicator:, - # ticket_change_indicator:, - # ticket_number:, - # travel_agency_code:, - # travel_agency_name:, - # trip_legs:, - # ** - # ) - # super - # end - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(ancillary:, computerized_reservation_system:, credit_reason_indicator:, departure_date:, origination_city_airport_code:, passenger_name:, restricted_ticket_indicator:, ticket_change_indicator:, ticket_number:, travel_agency_code:, travel_agency_name:, trip_legs:) + # Fields specific to travel. + # + # @param ancillary [Increase::Models::CardPayment::Element::CardSettlement::PurchaseDetails::Travel::Ancillary, nil] + # @param computerized_reservation_system [String, nil] + # @param credit_reason_indicator [Symbol, Increase::Models::CardPayment::Element::CardSettlement::PurchaseDetails::Travel::CreditReasonIndicator, nil] + # @param departure_date [Date, nil] + # @param origination_city_airport_code [String, nil] + # @param passenger_name [String, nil] + # @param restricted_ticket_indicator [Symbol, Increase::Models::CardPayment::Element::CardSettlement::PurchaseDetails::Travel::RestrictedTicketIndicator, nil] + # @param ticket_change_indicator [Symbol, Increase::Models::CardPayment::Element::CardSettlement::PurchaseDetails::Travel::TicketChangeIndicator, nil] + # @param ticket_number [String, nil] + # @param travel_agency_code [String, nil] + # @param travel_agency_name [String, nil] + # @param trip_legs [Array, nil] # @see Increase::Models::CardPayment::Element::CardSettlement::PurchaseDetails::Travel#ancillary class Ancillary < Increase::Internal::Type::BaseModel @@ -5634,27 +4886,14 @@ class Ancillary < Increase::Internal::Type::BaseModel # @return [String, nil] required :ticket_document_number, String, nil?: true - # @!parse - # # Ancillary purchases in addition to the airfare. - # # - # # @param connected_ticket_document_number [String, nil] - # # @param credit_reason_indicator [Symbol, Increase::Models::CardPayment::Element::CardSettlement::PurchaseDetails::Travel::Ancillary::CreditReasonIndicator, nil] - # # @param passenger_name_or_description [String, nil] - # # @param services [Array] - # # @param ticket_document_number [String, nil] - # # - # def initialize( - # connected_ticket_document_number:, - # credit_reason_indicator:, - # passenger_name_or_description:, - # services:, - # ticket_document_number:, - # ** - # ) - # super - # end - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(connected_ticket_document_number:, credit_reason_indicator:, passenger_name_or_description:, services:, ticket_document_number:) + # Ancillary purchases in addition to the airfare. + # + # @param connected_ticket_document_number [String, nil] + # @param credit_reason_indicator [Symbol, Increase::Models::CardPayment::Element::CardSettlement::PurchaseDetails::Travel::Ancillary::CreditReasonIndicator, nil] + # @param passenger_name_or_description [String, nil] + # @param services [Array] + # @param ticket_document_number [String, nil] # Indicates the reason for a credit to the cardholder. # @@ -5676,11 +4915,8 @@ module CreditReasonIndicator # Other OTHER = :other - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end class Service < Increase::Internal::Type::BaseModel @@ -5698,13 +4934,9 @@ class Service < Increase::Internal::Type::BaseModel # @return [String, nil] required :sub_category, String, nil?: true - # @!parse - # # @param category [Symbol, Increase::Models::CardPayment::Element::CardSettlement::PurchaseDetails::Travel::Ancillary::Service::Category, nil] - # # @param sub_category [String, nil] - # # - # def initialize(category:, sub_category:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(category:, sub_category:) + # @param category [Symbol, Increase::Models::CardPayment::Element::CardSettlement::PurchaseDetails::Travel::Ancillary::Service::Category, nil] + # @param sub_category [String, nil] # Category of the ancillary service. # @@ -5784,11 +5016,8 @@ module Category # Wi-fi WIFI = :wifi - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -5819,11 +5048,8 @@ module CreditReasonIndicator # Partial refund of airline ticket PARTIAL_REFUND_OF_AIRLINE_TICKET = :partial_refund_of_airline_ticket - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # Indicates whether this ticket is non-refundable. @@ -5838,11 +5064,8 @@ module RestrictedTicketIndicator # Restricted non-refundable ticket RESTRICTED_NON_REFUNDABLE_TICKET = :restricted_non_refundable_ticket - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # Indicates why a ticket was changed. @@ -5860,11 +5083,8 @@ module TicketChangeIndicator # New ticket NEW_TICKET = :new_ticket - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end class TripLeg < Increase::Internal::Type::BaseModel @@ -5906,27 +5126,13 @@ class TripLeg < Increase::Internal::Type::BaseModel enum: -> { Increase::Models::CardPayment::Element::CardSettlement::PurchaseDetails::Travel::TripLeg::StopOverCode }, nil?: true - # @!parse - # # @param carrier_code [String, nil] - # # @param destination_city_airport_code [String, nil] - # # @param fare_basis_code [String, nil] - # # @param flight_number [String, nil] - # # @param service_class [String, nil] - # # @param stop_over_code [Symbol, Increase::Models::CardPayment::Element::CardSettlement::PurchaseDetails::Travel::TripLeg::StopOverCode, nil] - # # - # def initialize( - # carrier_code:, - # destination_city_airport_code:, - # fare_basis_code:, - # flight_number:, - # service_class:, - # stop_over_code:, - # ** - # ) - # super - # end - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(carrier_code:, destination_city_airport_code:, fare_basis_code:, flight_number:, service_class:, stop_over_code:) + # @param carrier_code [String, nil] + # @param destination_city_airport_code [String, nil] + # @param fare_basis_code [String, nil] + # @param flight_number [String, nil] + # @param service_class [String, nil] + # @param stop_over_code [Symbol, Increase::Models::CardPayment::Element::CardSettlement::PurchaseDetails::Travel::TripLeg::StopOverCode, nil] # Indicates whether a stopover is allowed on this ticket. # @@ -5943,11 +5149,8 @@ module StopOverCode # Stop over not allowed STOP_OVER_NOT_ALLOWED = :stop_over_not_allowed - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -5962,11 +5165,8 @@ module Type CARD_SETTLEMENT = :card_settlement - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -6104,60 +5304,32 @@ class CardValidation < Increase::Internal::Type::BaseModel # @return [Increase::Models::CardPayment::Element::CardValidation::Verification] required :verification, -> { Increase::Models::CardPayment::Element::CardValidation::Verification } - # @!parse - # # A Card Validation object. This field will be present in the JSON response if and - # # only if `category` is equal to `card_validation`. Card Validations are requests - # # from a merchant to verify that a card number and optionally its address and/or - # # Card Verification Value are valid. - # # - # # @param id [String] - # # @param actioner [Symbol, Increase::Models::CardPayment::Element::CardValidation::Actioner] - # # @param card_payment_id [String] - # # @param currency [Symbol, Increase::Models::CardPayment::Element::CardValidation::Currency] - # # @param digital_wallet_token_id [String, nil] - # # @param merchant_acceptor_id [String] - # # @param merchant_category_code [String] - # # @param merchant_city [String, nil] - # # @param merchant_country [String] - # # @param merchant_descriptor [String] - # # @param merchant_postal_code [String, nil] - # # @param merchant_state [String, nil] - # # @param network_details [Increase::Models::CardPayment::Element::CardValidation::NetworkDetails] - # # @param network_identifiers [Increase::Models::CardPayment::Element::CardValidation::NetworkIdentifiers] - # # @param network_risk_score [Integer, nil] - # # @param physical_card_id [String, nil] - # # @param real_time_decision_id [String, nil] - # # @param terminal_id [String, nil] - # # @param type [Symbol, Increase::Models::CardPayment::Element::CardValidation::Type] - # # @param verification [Increase::Models::CardPayment::Element::CardValidation::Verification] - # # - # def initialize( - # id:, - # actioner:, - # card_payment_id:, - # currency:, - # digital_wallet_token_id:, - # merchant_acceptor_id:, - # merchant_category_code:, - # merchant_city:, - # merchant_country:, - # merchant_descriptor:, - # merchant_postal_code:, - # merchant_state:, - # network_details:, - # network_identifiers:, - # network_risk_score:, - # physical_card_id:, - # real_time_decision_id:, - # terminal_id:, - # type:, - # verification:, - # ** - # ) - # super - # end - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(id:, actioner:, card_payment_id:, currency:, digital_wallet_token_id:, merchant_acceptor_id:, merchant_category_code:, merchant_city:, merchant_country:, merchant_descriptor:, merchant_postal_code:, merchant_state:, network_details:, network_identifiers:, network_risk_score:, physical_card_id:, real_time_decision_id:, terminal_id:, type:, verification:) + # A Card Validation object. This field will be present in the JSON response if and + # only if `category` is equal to `card_validation`. Card Validations are requests + # from a merchant to verify that a card number and optionally its address and/or + # Card Verification Value are valid. + # + # @param id [String] + # @param actioner [Symbol, Increase::Models::CardPayment::Element::CardValidation::Actioner] + # @param card_payment_id [String] + # @param currency [Symbol, Increase::Models::CardPayment::Element::CardValidation::Currency] + # @param digital_wallet_token_id [String, nil] + # @param merchant_acceptor_id [String] + # @param merchant_category_code [String] + # @param merchant_city [String, nil] + # @param merchant_country [String] + # @param merchant_descriptor [String] + # @param merchant_postal_code [String, nil] + # @param merchant_state [String, nil] + # @param network_details [Increase::Models::CardPayment::Element::CardValidation::NetworkDetails] + # @param network_identifiers [Increase::Models::CardPayment::Element::CardValidation::NetworkIdentifiers] + # @param network_risk_score [Integer, nil] + # @param physical_card_id [String, nil] + # @param real_time_decision_id [String, nil] + # @param terminal_id [String, nil] + # @param type [Symbol, Increase::Models::CardPayment::Element::CardValidation::Type] + # @param verification [Increase::Models::CardPayment::Element::CardValidation::Verification] # Whether this authorization was approved by Increase, the card network through # stand-in processing, or the user through a real-time decision. @@ -6175,11 +5347,8 @@ module Actioner # This object was actioned by the network, through stand-in processing. NETWORK = :network - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the @@ -6207,11 +5376,8 @@ module Currency # US Dollar (USD) USD = :USD - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Increase::Models::CardPayment::Element::CardValidation#network_details @@ -6231,15 +5397,11 @@ class NetworkDetails < Increase::Internal::Type::BaseModel -> { Increase::Models::CardPayment::Element::CardValidation::NetworkDetails::Visa }, nil?: true - # @!parse - # # Fields specific to the `network`. - # # - # # @param category [Symbol, Increase::Models::CardPayment::Element::CardValidation::NetworkDetails::Category] - # # @param visa [Increase::Models::CardPayment::Element::CardValidation::NetworkDetails::Visa, nil] - # # - # def initialize(category:, visa:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(category:, visa:) + # Fields specific to the `network`. + # + # @param category [Symbol, Increase::Models::CardPayment::Element::CardValidation::NetworkDetails::Category] + # @param visa [Increase::Models::CardPayment::Element::CardValidation::NetworkDetails::Visa, nil] # The payment network used to process this card authorization. # @@ -6250,11 +5412,8 @@ module Category # Visa VISA = :visa - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Increase::Models::CardPayment::Element::CardValidation::NetworkDetails#visa @@ -6287,16 +5446,12 @@ class Visa < Increase::Internal::Type::BaseModel enum: -> { Increase::Models::CardPayment::Element::CardValidation::NetworkDetails::Visa::StandInProcessingReason }, nil?: true - # @!parse - # # Fields specific to the `visa` network. - # # - # # @param electronic_commerce_indicator [Symbol, Increase::Models::CardPayment::Element::CardValidation::NetworkDetails::Visa::ElectronicCommerceIndicator, nil] - # # @param point_of_service_entry_mode [Symbol, Increase::Models::CardPayment::Element::CardValidation::NetworkDetails::Visa::PointOfServiceEntryMode, nil] - # # @param stand_in_processing_reason [Symbol, Increase::Models::CardPayment::Element::CardValidation::NetworkDetails::Visa::StandInProcessingReason, nil] - # # - # def initialize(electronic_commerce_indicator:, point_of_service_entry_mode:, stand_in_processing_reason:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(electronic_commerce_indicator:, point_of_service_entry_mode:, stand_in_processing_reason:) + # Fields specific to the `visa` network. + # + # @param electronic_commerce_indicator [Symbol, Increase::Models::CardPayment::Element::CardValidation::NetworkDetails::Visa::ElectronicCommerceIndicator, nil] + # @param point_of_service_entry_mode [Symbol, Increase::Models::CardPayment::Element::CardValidation::NetworkDetails::Visa::PointOfServiceEntryMode, nil] + # @param stand_in_processing_reason [Symbol, Increase::Models::CardPayment::Element::CardValidation::NetworkDetails::Visa::StandInProcessingReason, nil] # For electronic commerce transactions, this identifies the level of security used # in obtaining the customer's payment credential. For mail or telephone order @@ -6331,11 +5486,8 @@ module ElectronicCommerceIndicator # Non-secure transaction: Use to identify an electronic commerce transaction that has no data protection. NON_SECURE_TRANSACTION = :non_secure_transaction - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # The method used to enter the cardholder's primary account number and card @@ -6375,11 +5527,8 @@ module PointOfServiceEntryMode # Contact chip card, without card verification value INTEGRATED_CIRCUIT_CARD_NO_CVV = :integrated_circuit_card_no_cvv - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # Only present when `actioner: network`. Describes why a card authorization was @@ -6412,11 +5561,8 @@ module StandInProcessingReason # An unspecific reason for stand-in processing. OTHER = :other - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -6445,16 +5591,12 @@ class NetworkIdentifiers < Increase::Internal::Type::BaseModel # @return [String, nil] required :transaction_id, String, nil?: true - # @!parse - # # Network-specific identifiers for a specific request or transaction. - # # - # # @param retrieval_reference_number [String, nil] - # # @param trace_number [String, nil] - # # @param transaction_id [String, nil] - # # - # def initialize(retrieval_reference_number:, trace_number:, transaction_id:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(retrieval_reference_number:, trace_number:, transaction_id:) + # Network-specific identifiers for a specific request or transaction. + # + # @param retrieval_reference_number [String, nil] + # @param trace_number [String, nil] + # @param transaction_id [String, nil] end # A constant representing the object's type. For this resource it will always be @@ -6466,11 +5608,8 @@ module Type CARD_VALIDATION = :card_validation - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Increase::Models::CardPayment::Element::CardValidation#verification @@ -6491,15 +5630,11 @@ class Verification < Increase::Internal::Type::BaseModel required :cardholder_address, -> { Increase::Models::CardPayment::Element::CardValidation::Verification::CardholderAddress } - # @!parse - # # Fields related to verification of cardholder-provided values. - # # - # # @param card_verification_code [Increase::Models::CardPayment::Element::CardValidation::Verification::CardVerificationCode] - # # @param cardholder_address [Increase::Models::CardPayment::Element::CardValidation::Verification::CardholderAddress] - # # - # def initialize(card_verification_code:, cardholder_address:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(card_verification_code:, cardholder_address:) + # Fields related to verification of cardholder-provided values. + # + # @param card_verification_code [Increase::Models::CardPayment::Element::CardValidation::Verification::CardVerificationCode] + # @param cardholder_address [Increase::Models::CardPayment::Element::CardValidation::Verification::CardholderAddress] # @see Increase::Models::CardPayment::Element::CardValidation::Verification#card_verification_code class CardVerificationCode < Increase::Internal::Type::BaseModel @@ -6510,15 +5645,11 @@ class CardVerificationCode < Increase::Internal::Type::BaseModel required :result, enum: -> { Increase::Models::CardPayment::Element::CardValidation::Verification::CardVerificationCode::Result } - # @!parse - # # Fields related to verification of the Card Verification Code, a 3-digit code on - # # the back of the card. - # # - # # @param result [Symbol, Increase::Models::CardPayment::Element::CardValidation::Verification::CardVerificationCode::Result] - # # - # def initialize(result:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(result:) + # Fields related to verification of the Card Verification Code, a 3-digit code on + # the back of the card. + # + # @param result [Symbol, Increase::Models::CardPayment::Element::CardValidation::Verification::CardVerificationCode::Result] # The result of verifying the Card Verification Code. # @@ -6535,11 +5666,8 @@ module Result # The card verification code did not match the one on file. NO_MATCH = :no_match - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -6577,19 +5705,15 @@ class CardholderAddress < Increase::Internal::Type::BaseModel required :result, enum: -> { Increase::Models::CardPayment::Element::CardValidation::Verification::CardholderAddress::Result } - # @!parse - # # Cardholder address provided in the authorization request and the address on file - # # we verified it against. - # # - # # @param actual_line1 [String, nil] - # # @param actual_postal_code [String, nil] - # # @param provided_line1 [String, nil] - # # @param provided_postal_code [String, nil] - # # @param result [Symbol, Increase::Models::CardPayment::Element::CardValidation::Verification::CardholderAddress::Result] - # # - # def initialize(actual_line1:, actual_postal_code:, provided_line1:, provided_postal_code:, result:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(actual_line1:, actual_postal_code:, provided_line1:, provided_postal_code:, result:) + # Cardholder address provided in the authorization request and the address on file + # we verified it against. + # + # @param actual_line1 [String, nil] + # @param actual_postal_code [String, nil] + # @param provided_line1 [String, nil] + # @param provided_postal_code [String, nil] + # @param result [Symbol, Increase::Models::CardPayment::Element::CardValidation::Verification::CardholderAddress::Result] # The address verification result returned to the card network. # @@ -6615,11 +5739,8 @@ module Result # Postal code and street address do not match. NO_MATCH = :no_match - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -6665,11 +5786,8 @@ module Category # Unknown card payment element. OTHER = :other - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -6710,18 +5828,14 @@ class State < Increase::Internal::Type::BaseModel # @return [Integer] required :settled_amount, Integer - # @!parse - # # The summarized state of this card payment. - # # - # # @param authorized_amount [Integer] - # # @param fuel_confirmed_amount [Integer] - # # @param incremented_amount [Integer] - # # @param reversed_amount [Integer] - # # @param settled_amount [Integer] - # # - # def initialize(authorized_amount:, fuel_confirmed_amount:, incremented_amount:, reversed_amount:, settled_amount:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(authorized_amount:, fuel_confirmed_amount:, incremented_amount:, reversed_amount:, settled_amount:) + # The summarized state of this card payment. + # + # @param authorized_amount [Integer] + # @param fuel_confirmed_amount [Integer] + # @param incremented_amount [Integer] + # @param reversed_amount [Integer] + # @param settled_amount [Integer] end # A constant representing the object's type. For this resource it will always be @@ -6733,11 +5847,8 @@ module Type CARD_PAYMENT = :card_payment - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end diff --git a/lib/increase/models/card_payment_list_params.rb b/lib/increase/models/card_payment_list_params.rb index 464efc19f..1b41453b8 100644 --- a/lib/increase/models/card_payment_list_params.rb +++ b/lib/increase/models/card_payment_list_params.rb @@ -4,126 +4,81 @@ module Increase module Models # @see Increase::Resources::CardPayments#list class CardPaymentListParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters - # @!attribute [r] account_id + # @!attribute account_id # Filter Card Payments to ones belonging to the specified Account. # # @return [String, nil] optional :account_id, String - # @!parse - # # @return [String] - # attr_writer :account_id - - # @!attribute [r] card_id + # @!attribute card_id # Filter Card Payments to ones belonging to the specified Card. # # @return [String, nil] optional :card_id, String - # @!parse - # # @return [String] - # attr_writer :card_id - - # @!attribute [r] created_at + # @!attribute created_at # # @return [Increase::Models::CardPaymentListParams::CreatedAt, nil] optional :created_at, -> { Increase::Models::CardPaymentListParams::CreatedAt } - # @!parse - # # @return [Increase::Models::CardPaymentListParams::CreatedAt] - # attr_writer :created_at - - # @!attribute [r] cursor + # @!attribute cursor # Return the page of entries after this one. # # @return [String, nil] optional :cursor, String - # @!parse - # # @return [String] - # attr_writer :cursor - - # @!attribute [r] limit + # @!attribute limit # Limit the size of the list that is returned. The default (and maximum) is 100 # objects. # # @return [Integer, nil] optional :limit, Integer - # @!parse - # # @return [Integer] - # attr_writer :limit - - # @!parse - # # @param account_id [String] - # # @param card_id [String] - # # @param created_at [Increase::Models::CardPaymentListParams::CreatedAt] - # # @param cursor [String] - # # @param limit [Integer] - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(account_id: nil, card_id: nil, created_at: nil, cursor: nil, limit: nil, request_options: {}, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(account_id: nil, card_id: nil, created_at: nil, cursor: nil, limit: nil, request_options: {}) + # @param account_id [String] + # @param card_id [String] + # @param created_at [Increase::Models::CardPaymentListParams::CreatedAt] + # @param cursor [String] + # @param limit [Integer] + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] class CreatedAt < Increase::Internal::Type::BaseModel - # @!attribute [r] after + # @!attribute after # Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) # timestamp. # # @return [Time, nil] optional :after, Time - # @!parse - # # @return [Time] - # attr_writer :after - - # @!attribute [r] before + # @!attribute before # Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) # timestamp. # # @return [Time, nil] optional :before, Time - # @!parse - # # @return [Time] - # attr_writer :before - - # @!attribute [r] on_or_after + # @!attribute on_or_after # Return results on or after this # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. # # @return [Time, nil] optional :on_or_after, Time - # @!parse - # # @return [Time] - # attr_writer :on_or_after - - # @!attribute [r] on_or_before + # @!attribute on_or_before # Return results on or before this # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. # # @return [Time, nil] optional :on_or_before, Time - # @!parse - # # @return [Time] - # attr_writer :on_or_before - - # @!parse - # # @param after [Time] - # # @param before [Time] - # # @param on_or_after [Time] - # # @param on_or_before [Time] - # # - # def initialize(after: nil, before: nil, on_or_after: nil, on_or_before: nil, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(after: nil, before: nil, on_or_after: nil, on_or_before: nil) + # @param after [Time] + # @param before [Time] + # @param on_or_after [Time] + # @param on_or_before [Time] end end end diff --git a/lib/increase/models/card_payment_retrieve_params.rb b/lib/increase/models/card_payment_retrieve_params.rb index 1a6b72ddc..a66b982bd 100644 --- a/lib/increase/models/card_payment_retrieve_params.rb +++ b/lib/increase/models/card_payment_retrieve_params.rb @@ -4,16 +4,11 @@ module Increase module Models # @see Increase::Resources::CardPayments#retrieve class CardPaymentRetrieveParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters - # @!parse - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(request_options: {}, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(request_options: {}) + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/increase/models/card_purchase_supplement.rb b/lib/increase/models/card_purchase_supplement.rb index b439128d6..4c1f23c3c 100644 --- a/lib/increase/models/card_purchase_supplement.rb +++ b/lib/increase/models/card_purchase_supplement.rb @@ -43,20 +43,16 @@ class CardPurchaseSupplement < Increase::Internal::Type::BaseModel # @return [Symbol, Increase::Models::CardPurchaseSupplement::Type] required :type, enum: -> { Increase::Models::CardPurchaseSupplement::Type } - # @!parse - # # Additional information about a card purchase (e.g., settlement or refund), such - # # as level 3 line item data. - # # - # # @param id [String] - # # @param card_payment_id [String, nil] - # # @param invoice [Increase::Models::CardPurchaseSupplement::Invoice, nil] - # # @param line_items [Array, nil] - # # @param transaction_id [String] - # # @param type [Symbol, Increase::Models::CardPurchaseSupplement::Type] - # # - # def initialize(id:, card_payment_id:, invoice:, line_items:, transaction_id:, type:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(id:, card_payment_id:, invoice:, line_items:, transaction_id:, type:) + # Additional information about a card purchase (e.g., settlement or refund), such + # as level 3 line item data. + # + # @param id [String] + # @param card_payment_id [String, nil] + # @param invoice [Increase::Models::CardPurchaseSupplement::Invoice, nil] + # @param line_items [Array, nil] + # @param transaction_id [String] + # @param type [Symbol, Increase::Models::CardPurchaseSupplement::Type] # @see Increase::Models::CardPurchaseSupplement#invoice class Invoice < Increase::Internal::Type::BaseModel @@ -162,49 +158,25 @@ class Invoice < Increase::Internal::Type::BaseModel # @return [String, nil] required :unique_value_added_tax_invoice_reference, String, nil?: true - # @!parse - # # Invoice-level information about the payment. - # # - # # @param discount_amount [Integer, nil] - # # @param discount_currency [String, nil] - # # @param discount_treatment_code [Symbol, Increase::Models::CardPurchaseSupplement::Invoice::DiscountTreatmentCode, nil] - # # @param duty_tax_amount [Integer, nil] - # # @param duty_tax_currency [String, nil] - # # @param order_date [Date, nil] - # # @param shipping_amount [Integer, nil] - # # @param shipping_currency [String, nil] - # # @param shipping_destination_country_code [String, nil] - # # @param shipping_destination_postal_code [String, nil] - # # @param shipping_source_postal_code [String, nil] - # # @param shipping_tax_amount [Integer, nil] - # # @param shipping_tax_currency [String, nil] - # # @param shipping_tax_rate [String, nil] - # # @param tax_treatments [Symbol, Increase::Models::CardPurchaseSupplement::Invoice::TaxTreatments, nil] - # # @param unique_value_added_tax_invoice_reference [String, nil] - # # - # def initialize( - # discount_amount:, - # discount_currency:, - # discount_treatment_code:, - # duty_tax_amount:, - # duty_tax_currency:, - # order_date:, - # shipping_amount:, - # shipping_currency:, - # shipping_destination_country_code:, - # shipping_destination_postal_code:, - # shipping_source_postal_code:, - # shipping_tax_amount:, - # shipping_tax_currency:, - # shipping_tax_rate:, - # tax_treatments:, - # unique_value_added_tax_invoice_reference:, - # ** - # ) - # super - # end - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(discount_amount:, discount_currency:, discount_treatment_code:, duty_tax_amount:, duty_tax_currency:, order_date:, shipping_amount:, shipping_currency:, shipping_destination_country_code:, shipping_destination_postal_code:, shipping_source_postal_code:, shipping_tax_amount:, shipping_tax_currency:, shipping_tax_rate:, tax_treatments:, unique_value_added_tax_invoice_reference:) + # Invoice-level information about the payment. + # + # @param discount_amount [Integer, nil] + # @param discount_currency [String, nil] + # @param discount_treatment_code [Symbol, Increase::Models::CardPurchaseSupplement::Invoice::DiscountTreatmentCode, nil] + # @param duty_tax_amount [Integer, nil] + # @param duty_tax_currency [String, nil] + # @param order_date [Date, nil] + # @param shipping_amount [Integer, nil] + # @param shipping_currency [String, nil] + # @param shipping_destination_country_code [String, nil] + # @param shipping_destination_postal_code [String, nil] + # @param shipping_source_postal_code [String, nil] + # @param shipping_tax_amount [Integer, nil] + # @param shipping_tax_currency [String, nil] + # @param shipping_tax_rate [String, nil] + # @param tax_treatments [Symbol, Increase::Models::CardPurchaseSupplement::Invoice::TaxTreatments, nil] + # @param unique_value_added_tax_invoice_reference [String, nil] # Indicates how the merchant applied the discount. # @@ -221,11 +193,8 @@ module DiscountTreatmentCode # Tax calculated on pre discount invoice total TAX_CALCULATED_ON_PRE_DISCOUNT_INVOICE_TOTAL = :tax_calculated_on_pre_discount_invoice_total - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # Indicates how the merchant applied taxes. @@ -249,11 +218,8 @@ module TaxTreatments # Gross price invoice level GROSS_PRICE_INVOICE_LEVEL = :gross_price_invoice_level - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -366,49 +332,24 @@ class LineItem < Increase::Internal::Type::BaseModel # @return [String, nil] required :unit_of_measure_code, String, nil?: true - # @!parse - # # @param id [String] - # # @param detail_indicator [Symbol, Increase::Models::CardPurchaseSupplement::LineItem::DetailIndicator, nil] - # # @param discount_amount [Integer, nil] - # # @param discount_currency [String, nil] - # # @param discount_treatment_code [Symbol, Increase::Models::CardPurchaseSupplement::LineItem::DiscountTreatmentCode, nil] - # # @param item_commodity_code [String, nil] - # # @param item_descriptor [String, nil] - # # @param item_quantity [String, nil] - # # @param product_code [String, nil] - # # @param sales_tax_amount [Integer, nil] - # # @param sales_tax_currency [String, nil] - # # @param sales_tax_rate [String, nil] - # # @param total_amount [Integer, nil] - # # @param total_amount_currency [String, nil] - # # @param unit_cost [String, nil] - # # @param unit_cost_currency [String, nil] - # # @param unit_of_measure_code [String, nil] - # # - # def initialize( - # id:, - # detail_indicator:, - # discount_amount:, - # discount_currency:, - # discount_treatment_code:, - # item_commodity_code:, - # item_descriptor:, - # item_quantity:, - # product_code:, - # sales_tax_amount:, - # sales_tax_currency:, - # sales_tax_rate:, - # total_amount:, - # total_amount_currency:, - # unit_cost:, - # unit_cost_currency:, - # unit_of_measure_code:, - # ** - # ) - # super - # end - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(id:, detail_indicator:, discount_amount:, discount_currency:, discount_treatment_code:, item_commodity_code:, item_descriptor:, item_quantity:, product_code:, sales_tax_amount:, sales_tax_currency:, sales_tax_rate:, total_amount:, total_amount_currency:, unit_cost:, unit_cost_currency:, unit_of_measure_code:) + # @param id [String] + # @param detail_indicator [Symbol, Increase::Models::CardPurchaseSupplement::LineItem::DetailIndicator, nil] + # @param discount_amount [Integer, nil] + # @param discount_currency [String, nil] + # @param discount_treatment_code [Symbol, Increase::Models::CardPurchaseSupplement::LineItem::DiscountTreatmentCode, nil] + # @param item_commodity_code [String, nil] + # @param item_descriptor [String, nil] + # @param item_quantity [String, nil] + # @param product_code [String, nil] + # @param sales_tax_amount [Integer, nil] + # @param sales_tax_currency [String, nil] + # @param sales_tax_rate [String, nil] + # @param total_amount [Integer, nil] + # @param total_amount_currency [String, nil] + # @param unit_cost [String, nil] + # @param unit_cost_currency [String, nil] + # @param unit_of_measure_code [String, nil] # Indicates the type of line item. # @@ -425,11 +366,8 @@ module DetailIndicator # Purchase PAYMENT = :payment - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # Indicates how the merchant applied the discount for this specific line item. @@ -447,11 +385,8 @@ module DiscountTreatmentCode # Tax calculated on pre discount line item total TAX_CALCULATED_ON_PRE_DISCOUNT_LINE_ITEM_TOTAL = :tax_calculated_on_pre_discount_line_item_total - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -464,11 +399,8 @@ module Type CARD_PURCHASE_SUPPLEMENT = :card_purchase_supplement - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end diff --git a/lib/increase/models/card_purchase_supplement_list_params.rb b/lib/increase/models/card_purchase_supplement_list_params.rb index 5d318f8b4..51dd3e2f0 100644 --- a/lib/increase/models/card_purchase_supplement_list_params.rb +++ b/lib/increase/models/card_purchase_supplement_list_params.rb @@ -4,116 +4,75 @@ module Increase module Models # @see Increase::Resources::CardPurchaseSupplements#list class CardPurchaseSupplementListParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters - # @!attribute [r] card_payment_id + # @!attribute card_payment_id # Filter Card Purchase Supplements to ones belonging to the specified Card # Payment. # # @return [String, nil] optional :card_payment_id, String - # @!parse - # # @return [String] - # attr_writer :card_payment_id - - # @!attribute [r] created_at + # @!attribute created_at # # @return [Increase::Models::CardPurchaseSupplementListParams::CreatedAt, nil] optional :created_at, -> { Increase::Models::CardPurchaseSupplementListParams::CreatedAt } - # @!parse - # # @return [Increase::Models::CardPurchaseSupplementListParams::CreatedAt] - # attr_writer :created_at - - # @!attribute [r] cursor + # @!attribute cursor # Return the page of entries after this one. # # @return [String, nil] optional :cursor, String - # @!parse - # # @return [String] - # attr_writer :cursor - - # @!attribute [r] limit + # @!attribute limit # Limit the size of the list that is returned. The default (and maximum) is 100 # objects. # # @return [Integer, nil] optional :limit, Integer - # @!parse - # # @return [Integer] - # attr_writer :limit - - # @!parse - # # @param card_payment_id [String] - # # @param created_at [Increase::Models::CardPurchaseSupplementListParams::CreatedAt] - # # @param cursor [String] - # # @param limit [Integer] - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(card_payment_id: nil, created_at: nil, cursor: nil, limit: nil, request_options: {}, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(card_payment_id: nil, created_at: nil, cursor: nil, limit: nil, request_options: {}) + # @param card_payment_id [String] + # @param created_at [Increase::Models::CardPurchaseSupplementListParams::CreatedAt] + # @param cursor [String] + # @param limit [Integer] + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] class CreatedAt < Increase::Internal::Type::BaseModel - # @!attribute [r] after + # @!attribute after # Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) # timestamp. # # @return [Time, nil] optional :after, Time - # @!parse - # # @return [Time] - # attr_writer :after - - # @!attribute [r] before + # @!attribute before # Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) # timestamp. # # @return [Time, nil] optional :before, Time - # @!parse - # # @return [Time] - # attr_writer :before - - # @!attribute [r] on_or_after + # @!attribute on_or_after # Return results on or after this # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. # # @return [Time, nil] optional :on_or_after, Time - # @!parse - # # @return [Time] - # attr_writer :on_or_after - - # @!attribute [r] on_or_before + # @!attribute on_or_before # Return results on or before this # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. # # @return [Time, nil] optional :on_or_before, Time - # @!parse - # # @return [Time] - # attr_writer :on_or_before - - # @!parse - # # @param after [Time] - # # @param before [Time] - # # @param on_or_after [Time] - # # @param on_or_before [Time] - # # - # def initialize(after: nil, before: nil, on_or_after: nil, on_or_before: nil, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(after: nil, before: nil, on_or_after: nil, on_or_before: nil) + # @param after [Time] + # @param before [Time] + # @param on_or_after [Time] + # @param on_or_before [Time] end end end diff --git a/lib/increase/models/card_purchase_supplement_retrieve_params.rb b/lib/increase/models/card_purchase_supplement_retrieve_params.rb index 11db06cc2..a03cd7505 100644 --- a/lib/increase/models/card_purchase_supplement_retrieve_params.rb +++ b/lib/increase/models/card_purchase_supplement_retrieve_params.rb @@ -4,16 +4,11 @@ module Increase module Models # @see Increase::Resources::CardPurchaseSupplements#retrieve class CardPurchaseSupplementRetrieveParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters - # @!parse - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(request_options: {}, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(request_options: {}) + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/increase/models/card_retrieve_params.rb b/lib/increase/models/card_retrieve_params.rb index 52cad2c16..bd578d6a4 100644 --- a/lib/increase/models/card_retrieve_params.rb +++ b/lib/increase/models/card_retrieve_params.rb @@ -4,16 +4,11 @@ module Increase module Models # @see Increase::Resources::Cards#retrieve class CardRetrieveParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters - # @!parse - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(request_options: {}, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(request_options: {}) + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/increase/models/card_update_params.rb b/lib/increase/models/card_update_params.rb index a3d4acf50..23bdffb96 100644 --- a/lib/increase/models/card_update_params.rb +++ b/lib/increase/models/card_update_params.rb @@ -4,31 +4,22 @@ module Increase module Models # @see Increase::Resources::Cards#update class CardUpdateParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters - # @!attribute [r] billing_address + # @!attribute billing_address # The card's updated billing address. # # @return [Increase::Models::CardUpdateParams::BillingAddress, nil] optional :billing_address, -> { Increase::Models::CardUpdateParams::BillingAddress } - # @!parse - # # @return [Increase::Models::CardUpdateParams::BillingAddress] - # attr_writer :billing_address - - # @!attribute [r] description + # @!attribute description # The description you choose to give the card. # # @return [String, nil] optional :description, String - # @!parse - # # @return [String] - # attr_writer :description - - # @!attribute [r] digital_wallet + # @!attribute digital_wallet # The contact information used in the two-factor steps for digital wallet card # creation. At least one field must be present to complete the digital wallet # steps. @@ -36,52 +27,26 @@ class CardUpdateParams < Increase::Internal::Type::BaseModel # @return [Increase::Models::CardUpdateParams::DigitalWallet, nil] optional :digital_wallet, -> { Increase::Models::CardUpdateParams::DigitalWallet } - # @!parse - # # @return [Increase::Models::CardUpdateParams::DigitalWallet] - # attr_writer :digital_wallet - - # @!attribute [r] entity_id + # @!attribute entity_id # The Entity the card belongs to. You only need to supply this in rare situations # when the card is not for the Account holder. # # @return [String, nil] optional :entity_id, String - # @!parse - # # @return [String] - # attr_writer :entity_id - - # @!attribute [r] status + # @!attribute status # The status to update the Card with. # # @return [Symbol, Increase::Models::CardUpdateParams::Status, nil] optional :status, enum: -> { Increase::Models::CardUpdateParams::Status } - # @!parse - # # @return [Symbol, Increase::Models::CardUpdateParams::Status] - # attr_writer :status - - # @!parse - # # @param billing_address [Increase::Models::CardUpdateParams::BillingAddress] - # # @param description [String] - # # @param digital_wallet [Increase::Models::CardUpdateParams::DigitalWallet] - # # @param entity_id [String] - # # @param status [Symbol, Increase::Models::CardUpdateParams::Status] - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize( - # billing_address: nil, - # description: nil, - # digital_wallet: nil, - # entity_id: nil, - # status: nil, - # request_options: {}, - # ** - # ) - # super - # end - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(billing_address: nil, description: nil, digital_wallet: nil, entity_id: nil, status: nil, request_options: {}) + # @param billing_address [Increase::Models::CardUpdateParams::BillingAddress] + # @param description [String] + # @param digital_wallet [Increase::Models::CardUpdateParams::DigitalWallet] + # @param entity_id [String] + # @param status [Symbol, Increase::Models::CardUpdateParams::Status] + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] class BillingAddress < Increase::Internal::Type::BaseModel # @!attribute city @@ -108,75 +73,51 @@ class BillingAddress < Increase::Internal::Type::BaseModel # @return [String] required :state, String - # @!attribute [r] line2 + # @!attribute line2 # The second line of the billing address. # # @return [String, nil] optional :line2, String - # @!parse - # # @return [String] - # attr_writer :line2 - - # @!parse - # # The card's updated billing address. - # # - # # @param city [String] - # # @param line1 [String] - # # @param postal_code [String] - # # @param state [String] - # # @param line2 [String] - # # - # def initialize(city:, line1:, postal_code:, state:, line2: nil, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(city:, line1:, postal_code:, state:, line2: nil) + # The card's updated billing address. + # + # @param city [String] + # @param line1 [String] + # @param postal_code [String] + # @param state [String] + # @param line2 [String] end class DigitalWallet < Increase::Internal::Type::BaseModel - # @!attribute [r] digital_card_profile_id + # @!attribute digital_card_profile_id # The digital card profile assigned to this digital card. # # @return [String, nil] optional :digital_card_profile_id, String - # @!parse - # # @return [String] - # attr_writer :digital_card_profile_id - - # @!attribute [r] email + # @!attribute email # An email address that can be used to verify the cardholder via one-time passcode # over email. # # @return [String, nil] optional :email, String - # @!parse - # # @return [String] - # attr_writer :email - - # @!attribute [r] phone + # @!attribute phone # A phone number that can be used to verify the cardholder via one-time passcode # over SMS. # # @return [String, nil] optional :phone, String - # @!parse - # # @return [String] - # attr_writer :phone - - # @!parse - # # The contact information used in the two-factor steps for digital wallet card - # # creation. At least one field must be present to complete the digital wallet - # # steps. - # # - # # @param digital_card_profile_id [String] - # # @param email [String] - # # @param phone [String] - # # - # def initialize(digital_card_profile_id: nil, email: nil, phone: nil, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(digital_card_profile_id: nil, email: nil, phone: nil) + # The contact information used in the two-factor steps for digital wallet card + # creation. At least one field must be present to complete the digital wallet + # steps. + # + # @param digital_card_profile_id [String] + # @param email [String] + # @param phone [String] end # The status to update the Card with. @@ -192,11 +133,8 @@ module Status # The card is permanently canceled. CANCELED = :canceled - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end diff --git a/lib/increase/models/check_deposit.rb b/lib/increase/models/check_deposit.rb index d72577a28..96d19c2d7 100644 --- a/lib/increase/models/check_deposit.rb +++ b/lib/increase/models/check_deposit.rb @@ -123,53 +123,27 @@ class CheckDeposit < Increase::Internal::Type::BaseModel # @return [Symbol, Increase::Models::CheckDeposit::Type] required :type, enum: -> { Increase::Models::CheckDeposit::Type } - # @!parse - # # Check Deposits allow you to deposit images of paper checks into your account. - # # - # # @param id [String] - # # @param account_id [String] - # # @param amount [Integer] - # # @param back_image_file_id [String, nil] - # # @param created_at [Time] - # # @param deposit_acceptance [Increase::Models::CheckDeposit::DepositAcceptance, nil] - # # @param deposit_rejection [Increase::Models::CheckDeposit::DepositRejection, nil] - # # @param deposit_return [Increase::Models::CheckDeposit::DepositReturn, nil] - # # @param deposit_submission [Increase::Models::CheckDeposit::DepositSubmission, nil] - # # @param description [String, nil] - # # @param front_image_file_id [String] - # # @param idempotency_key [String, nil] - # # @param inbound_funds_hold [Increase::Models::CheckDeposit::InboundFundsHold, nil] - # # @param inbound_mail_item_id [String, nil] - # # @param lockbox_id [String, nil] - # # @param status [Symbol, Increase::Models::CheckDeposit::Status] - # # @param transaction_id [String, nil] - # # @param type [Symbol, Increase::Models::CheckDeposit::Type] - # # - # def initialize( - # id:, - # account_id:, - # amount:, - # back_image_file_id:, - # created_at:, - # deposit_acceptance:, - # deposit_rejection:, - # deposit_return:, - # deposit_submission:, - # description:, - # front_image_file_id:, - # idempotency_key:, - # inbound_funds_hold:, - # inbound_mail_item_id:, - # lockbox_id:, - # status:, - # transaction_id:, - # type:, - # ** - # ) - # super - # end - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(id:, account_id:, amount:, back_image_file_id:, created_at:, deposit_acceptance:, deposit_rejection:, deposit_return:, deposit_submission:, description:, front_image_file_id:, idempotency_key:, inbound_funds_hold:, inbound_mail_item_id:, lockbox_id:, status:, transaction_id:, type:) + # Check Deposits allow you to deposit images of paper checks into your account. + # + # @param id [String] + # @param account_id [String] + # @param amount [Integer] + # @param back_image_file_id [String, nil] + # @param created_at [Time] + # @param deposit_acceptance [Increase::Models::CheckDeposit::DepositAcceptance, nil] + # @param deposit_rejection [Increase::Models::CheckDeposit::DepositRejection, nil] + # @param deposit_return [Increase::Models::CheckDeposit::DepositReturn, nil] + # @param deposit_submission [Increase::Models::CheckDeposit::DepositSubmission, nil] + # @param description [String, nil] + # @param front_image_file_id [String] + # @param idempotency_key [String, nil] + # @param inbound_funds_hold [Increase::Models::CheckDeposit::InboundFundsHold, nil] + # @param inbound_mail_item_id [String, nil] + # @param lockbox_id [String, nil] + # @param status [Symbol, Increase::Models::CheckDeposit::Status] + # @param transaction_id [String, nil] + # @param type [Symbol, Increase::Models::CheckDeposit::Type] # @see Increase::Models::CheckDeposit#deposit_acceptance class DepositAcceptance < Increase::Internal::Type::BaseModel @@ -219,32 +193,17 @@ class DepositAcceptance < Increase::Internal::Type::BaseModel # @return [String, nil] required :serial_number, String, nil?: true - # @!parse - # # If your deposit is successfully parsed and accepted by Increase, this will - # # contain details of the parsed check. - # # - # # @param account_number [String] - # # @param amount [Integer] - # # @param auxiliary_on_us [String, nil] - # # @param check_deposit_id [String] - # # @param currency [Symbol, Increase::Models::CheckDeposit::DepositAcceptance::Currency] - # # @param routing_number [String] - # # @param serial_number [String, nil] - # # - # def initialize( - # account_number:, - # amount:, - # auxiliary_on_us:, - # check_deposit_id:, - # currency:, - # routing_number:, - # serial_number:, - # ** - # ) - # super - # end - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(account_number:, amount:, auxiliary_on_us:, check_deposit_id:, currency:, routing_number:, serial_number:) + # If your deposit is successfully parsed and accepted by Increase, this will + # contain details of the parsed check. + # + # @param account_number [String] + # @param amount [Integer] + # @param auxiliary_on_us [String, nil] + # @param check_deposit_id [String] + # @param currency [Symbol, Increase::Models::CheckDeposit::DepositAcceptance::Currency] + # @param routing_number [String] + # @param serial_number [String, nil] # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the # transaction's currency. @@ -271,11 +230,8 @@ module Currency # US Dollar (USD) USD = :USD - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -320,20 +276,16 @@ class DepositRejection < Increase::Internal::Type::BaseModel # @return [Time] required :rejected_at, Time - # @!parse - # # If your deposit is rejected by Increase, this will contain details as to why it - # # was rejected. - # # - # # @param amount [Integer] - # # @param check_deposit_id [String] - # # @param currency [Symbol, Increase::Models::CheckDeposit::DepositRejection::Currency] - # # @param declined_transaction_id [String] - # # @param reason [Symbol, Increase::Models::CheckDeposit::DepositRejection::Reason] - # # @param rejected_at [Time] - # # - # def initialize(amount:, check_deposit_id:, currency:, declined_transaction_id:, reason:, rejected_at:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(amount:, check_deposit_id:, currency:, declined_transaction_id:, reason:, rejected_at:) + # If your deposit is rejected by Increase, this will contain details as to why it + # was rejected. + # + # @param amount [Integer] + # @param check_deposit_id [String] + # @param currency [Symbol, Increase::Models::CheckDeposit::DepositRejection::Currency] + # @param declined_transaction_id [String] + # @param reason [Symbol, Increase::Models::CheckDeposit::DepositRejection::Reason] + # @param rejected_at [Time] # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the check's # currency. @@ -360,11 +312,8 @@ module Currency # US Dollar (USD) USD = :USD - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # Why the check deposit was rejected. @@ -406,11 +355,8 @@ module Reason # The check was rejected for an unknown reason. UNKNOWN = :unknown - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -456,20 +402,16 @@ class DepositReturn < Increase::Internal::Type::BaseModel # @return [String] required :transaction_id, String - # @!parse - # # If your deposit is returned, this will contain details as to why it was - # # returned. - # # - # # @param amount [Integer] - # # @param check_deposit_id [String] - # # @param currency [Symbol, Increase::Models::CheckDeposit::DepositReturn::Currency] - # # @param return_reason [Symbol, Increase::Models::CheckDeposit::DepositReturn::ReturnReason] - # # @param returned_at [Time] - # # @param transaction_id [String] - # # - # def initialize(amount:, check_deposit_id:, currency:, return_reason:, returned_at:, transaction_id:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(amount:, check_deposit_id:, currency:, return_reason:, returned_at:, transaction_id:) + # If your deposit is returned, this will contain details as to why it was + # returned. + # + # @param amount [Integer] + # @param check_deposit_id [String] + # @param currency [Symbol, Increase::Models::CheckDeposit::DepositReturn::Currency] + # @param return_reason [Symbol, Increase::Models::CheckDeposit::DepositReturn::ReturnReason] + # @param returned_at [Time] + # @param transaction_id [String] # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the # transaction's currency. @@ -496,11 +438,8 @@ module Currency # US Dollar (USD) USD = :USD - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # Why this check was returned by the bank holding the account it was drawn @@ -588,11 +527,8 @@ module ReturnReason # The bank sold this account and no longer services this customer. BRANCH_OR_ACCOUNT_SOLD = :branch_or_account_sold - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -620,17 +556,13 @@ class DepositSubmission < Increase::Internal::Type::BaseModel # @return [Time] required :submitted_at, Time - # @!parse - # # After the check is parsed, it is submitted to the Check21 network for - # # processing. This will contain details of the submission. - # # - # # @param back_file_id [String] - # # @param front_file_id [String] - # # @param submitted_at [Time] - # # - # def initialize(back_file_id:, front_file_id:, submitted_at:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(back_file_id:, front_file_id:, submitted_at:) + # After the check is parsed, it is submitted to the Check21 network for + # processing. This will contain details of the submission. + # + # @param back_file_id [String] + # @param front_file_id [String] + # @param submitted_at [Time] end # @see Increase::Models::CheckDeposit#inbound_funds_hold @@ -700,38 +632,20 @@ class InboundFundsHold < Increase::Internal::Type::BaseModel # @return [Symbol, Increase::Models::CheckDeposit::InboundFundsHold::Type] required :type, enum: -> { Increase::Models::CheckDeposit::InboundFundsHold::Type } - # @!parse - # # Increase will sometimes hold the funds for Check Deposits. If funds are held, - # # this sub-object will contain details of the hold. - # # - # # @param id [String] - # # @param amount [Integer] - # # @param automatically_releases_at [Time] - # # @param created_at [Time] - # # @param currency [Symbol, Increase::Models::CheckDeposit::InboundFundsHold::Currency] - # # @param held_transaction_id [String, nil] - # # @param pending_transaction_id [String, nil] - # # @param released_at [Time, nil] - # # @param status [Symbol, Increase::Models::CheckDeposit::InboundFundsHold::Status] - # # @param type [Symbol, Increase::Models::CheckDeposit::InboundFundsHold::Type] - # # - # def initialize( - # id:, - # amount:, - # automatically_releases_at:, - # created_at:, - # currency:, - # held_transaction_id:, - # pending_transaction_id:, - # released_at:, - # status:, - # type:, - # ** - # ) - # super - # end - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(id:, amount:, automatically_releases_at:, created_at:, currency:, held_transaction_id:, pending_transaction_id:, released_at:, status:, type:) + # Increase will sometimes hold the funds for Check Deposits. If funds are held, + # this sub-object will contain details of the hold. + # + # @param id [String] + # @param amount [Integer] + # @param automatically_releases_at [Time] + # @param created_at [Time] + # @param currency [Symbol, Increase::Models::CheckDeposit::InboundFundsHold::Currency] + # @param held_transaction_id [String, nil] + # @param pending_transaction_id [String, nil] + # @param released_at [Time, nil] + # @param status [Symbol, Increase::Models::CheckDeposit::InboundFundsHold::Status] + # @param type [Symbol, Increase::Models::CheckDeposit::InboundFundsHold::Type] # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the hold's # currency. @@ -758,11 +672,8 @@ module Currency # US Dollar (USD) USD = :USD - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # The status of the hold. @@ -777,11 +688,8 @@ module Status # Funds have been released. COMPLETE = :complete - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # A constant representing the object's type. For this resource it will always be @@ -793,11 +701,8 @@ module Type INBOUND_FUNDS_HOLD = :inbound_funds_hold - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -819,11 +724,8 @@ module Status # The Check Deposit has been returned. RETURNED = :returned - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # A constant representing the object's type. For this resource it will always be @@ -835,11 +737,8 @@ module Type CHECK_DEPOSIT = :check_deposit - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end diff --git a/lib/increase/models/check_deposit_create_params.rb b/lib/increase/models/check_deposit_create_params.rb index 9e490eeee..ccdc25fa4 100644 --- a/lib/increase/models/check_deposit_create_params.rb +++ b/lib/increase/models/check_deposit_create_params.rb @@ -4,8 +4,7 @@ module Increase module Models # @see Increase::Resources::CheckDeposits#create class CheckDepositCreateParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters # @!attribute account_id @@ -32,27 +31,19 @@ class CheckDepositCreateParams < Increase::Internal::Type::BaseModel # @return [String] required :front_image_file_id, String - # @!attribute [r] description + # @!attribute description # The description you choose to give the Check Deposit, for display purposes only. # # @return [String, nil] optional :description, String - # @!parse - # # @return [String] - # attr_writer :description - - # @!parse - # # @param account_id [String] - # # @param amount [Integer] - # # @param back_image_file_id [String] - # # @param front_image_file_id [String] - # # @param description [String] - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(account_id:, amount:, back_image_file_id:, front_image_file_id:, description: nil, request_options: {}, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(account_id:, amount:, back_image_file_id:, front_image_file_id:, description: nil, request_options: {}) + # @param account_id [String] + # @param amount [Integer] + # @param back_image_file_id [String] + # @param front_image_file_id [String] + # @param description [String] + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/increase/models/check_deposit_list_params.rb b/lib/increase/models/check_deposit_list_params.rb index 5b6ac3ebd..f13122ade 100644 --- a/lib/increase/models/check_deposit_list_params.rb +++ b/lib/increase/models/check_deposit_list_params.rb @@ -4,40 +4,27 @@ module Increase module Models # @see Increase::Resources::CheckDeposits#list class CheckDepositListParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters - # @!attribute [r] account_id + # @!attribute account_id # Filter Check Deposits to those belonging to the specified Account. # # @return [String, nil] optional :account_id, String - # @!parse - # # @return [String] - # attr_writer :account_id - - # @!attribute [r] created_at + # @!attribute created_at # # @return [Increase::Models::CheckDepositListParams::CreatedAt, nil] optional :created_at, -> { Increase::Models::CheckDepositListParams::CreatedAt } - # @!parse - # # @return [Increase::Models::CheckDepositListParams::CreatedAt] - # attr_writer :created_at - - # @!attribute [r] cursor + # @!attribute cursor # Return the page of entries after this one. # # @return [String, nil] optional :cursor, String - # @!parse - # # @return [String] - # attr_writer :cursor - - # @!attribute [r] idempotency_key + # @!attribute idempotency_key # Filter records to the one with the specified `idempotency_key` you chose for # that object. This value is unique across Increase and is used to ensure that a # request is only processed once. Learn more about @@ -46,87 +33,55 @@ class CheckDepositListParams < Increase::Internal::Type::BaseModel # @return [String, nil] optional :idempotency_key, String - # @!parse - # # @return [String] - # attr_writer :idempotency_key - - # @!attribute [r] limit + # @!attribute limit # Limit the size of the list that is returned. The default (and maximum) is 100 # objects. # # @return [Integer, nil] optional :limit, Integer - # @!parse - # # @return [Integer] - # attr_writer :limit - - # @!parse - # # @param account_id [String] - # # @param created_at [Increase::Models::CheckDepositListParams::CreatedAt] - # # @param cursor [String] - # # @param idempotency_key [String] - # # @param limit [Integer] - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(account_id: nil, created_at: nil, cursor: nil, idempotency_key: nil, limit: nil, request_options: {}, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(account_id: nil, created_at: nil, cursor: nil, idempotency_key: nil, limit: nil, request_options: {}) + # @param account_id [String] + # @param created_at [Increase::Models::CheckDepositListParams::CreatedAt] + # @param cursor [String] + # @param idempotency_key [String] + # @param limit [Integer] + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] class CreatedAt < Increase::Internal::Type::BaseModel - # @!attribute [r] after + # @!attribute after # Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) # timestamp. # # @return [Time, nil] optional :after, Time - # @!parse - # # @return [Time] - # attr_writer :after - - # @!attribute [r] before + # @!attribute before # Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) # timestamp. # # @return [Time, nil] optional :before, Time - # @!parse - # # @return [Time] - # attr_writer :before - - # @!attribute [r] on_or_after + # @!attribute on_or_after # Return results on or after this # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. # # @return [Time, nil] optional :on_or_after, Time - # @!parse - # # @return [Time] - # attr_writer :on_or_after - - # @!attribute [r] on_or_before + # @!attribute on_or_before # Return results on or before this # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. # # @return [Time, nil] optional :on_or_before, Time - # @!parse - # # @return [Time] - # attr_writer :on_or_before - - # @!parse - # # @param after [Time] - # # @param before [Time] - # # @param on_or_after [Time] - # # @param on_or_before [Time] - # # - # def initialize(after: nil, before: nil, on_or_after: nil, on_or_before: nil, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(after: nil, before: nil, on_or_after: nil, on_or_before: nil) + # @param after [Time] + # @param before [Time] + # @param on_or_after [Time] + # @param on_or_before [Time] end end end diff --git a/lib/increase/models/check_deposit_retrieve_params.rb b/lib/increase/models/check_deposit_retrieve_params.rb index 91700e681..d708547e3 100644 --- a/lib/increase/models/check_deposit_retrieve_params.rb +++ b/lib/increase/models/check_deposit_retrieve_params.rb @@ -4,16 +4,11 @@ module Increase module Models # @see Increase::Resources::CheckDeposits#retrieve class CheckDepositRetrieveParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters - # @!parse - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(request_options: {}, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(request_options: {}) + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/increase/models/check_transfer.rb b/lib/increase/models/check_transfer.rb index c469cf271..5658885c5 100644 --- a/lib/increase/models/check_transfer.rb +++ b/lib/increase/models/check_transfer.rb @@ -158,64 +158,33 @@ class CheckTransfer < Increase::Internal::Type::BaseModel # @return [Symbol, Increase::Models::CheckTransfer::Type] required :type, enum: -> { Increase::Models::CheckTransfer::Type } - # @!parse - # # Check Transfers move funds from your Increase account by mailing a physical - # # check. - # # - # # @param id [String] - # # @param account_id [String] - # # @param account_number [String] - # # @param amount [Integer] - # # @param approval [Increase::Models::CheckTransfer::Approval, nil] - # # @param approved_inbound_check_deposit_id [String, nil] - # # @param cancellation [Increase::Models::CheckTransfer::Cancellation, nil] - # # @param check_number [String] - # # @param created_at [Time] - # # @param created_by [Increase::Models::CheckTransfer::CreatedBy, nil] - # # @param currency [Symbol, Increase::Models::CheckTransfer::Currency] - # # @param fulfillment_method [Symbol, Increase::Models::CheckTransfer::FulfillmentMethod] - # # @param idempotency_key [String, nil] - # # @param mailing [Increase::Models::CheckTransfer::Mailing, nil] - # # @param pending_transaction_id [String, nil] - # # @param physical_check [Increase::Models::CheckTransfer::PhysicalCheck, nil] - # # @param routing_number [String] - # # @param source_account_number_id [String, nil] - # # @param status [Symbol, Increase::Models::CheckTransfer::Status] - # # @param stop_payment_request [Increase::Models::CheckTransfer::StopPaymentRequest, nil] - # # @param submission [Increase::Models::CheckTransfer::Submission, nil] - # # @param third_party [Increase::Models::CheckTransfer::ThirdParty, nil] - # # @param type [Symbol, Increase::Models::CheckTransfer::Type] - # # - # def initialize( - # id:, - # account_id:, - # account_number:, - # amount:, - # approval:, - # approved_inbound_check_deposit_id:, - # cancellation:, - # check_number:, - # created_at:, - # created_by:, - # currency:, - # fulfillment_method:, - # idempotency_key:, - # mailing:, - # pending_transaction_id:, - # physical_check:, - # routing_number:, - # source_account_number_id:, - # status:, - # stop_payment_request:, - # submission:, - # third_party:, - # type:, - # ** - # ) - # super - # end - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(id:, account_id:, account_number:, amount:, approval:, approved_inbound_check_deposit_id:, cancellation:, check_number:, created_at:, created_by:, currency:, fulfillment_method:, idempotency_key:, mailing:, pending_transaction_id:, physical_check:, routing_number:, source_account_number_id:, status:, stop_payment_request:, submission:, third_party:, type:) + # Check Transfers move funds from your Increase account by mailing a physical + # check. + # + # @param id [String] + # @param account_id [String] + # @param account_number [String] + # @param amount [Integer] + # @param approval [Increase::Models::CheckTransfer::Approval, nil] + # @param approved_inbound_check_deposit_id [String, nil] + # @param cancellation [Increase::Models::CheckTransfer::Cancellation, nil] + # @param check_number [String] + # @param created_at [Time] + # @param created_by [Increase::Models::CheckTransfer::CreatedBy, nil] + # @param currency [Symbol, Increase::Models::CheckTransfer::Currency] + # @param fulfillment_method [Symbol, Increase::Models::CheckTransfer::FulfillmentMethod] + # @param idempotency_key [String, nil] + # @param mailing [Increase::Models::CheckTransfer::Mailing, nil] + # @param pending_transaction_id [String, nil] + # @param physical_check [Increase::Models::CheckTransfer::PhysicalCheck, nil] + # @param routing_number [String] + # @param source_account_number_id [String, nil] + # @param status [Symbol, Increase::Models::CheckTransfer::Status] + # @param stop_payment_request [Increase::Models::CheckTransfer::StopPaymentRequest, nil] + # @param submission [Increase::Models::CheckTransfer::Submission, nil] + # @param third_party [Increase::Models::CheckTransfer::ThirdParty, nil] + # @param type [Symbol, Increase::Models::CheckTransfer::Type] # @see Increase::Models::CheckTransfer#approval class Approval < Increase::Internal::Type::BaseModel @@ -233,16 +202,12 @@ class Approval < Increase::Internal::Type::BaseModel # @return [String, nil] required :approved_by, String, nil?: true - # @!parse - # # If your account requires approvals for transfers and the transfer was approved, - # # this will contain details of the approval. - # # - # # @param approved_at [Time] - # # @param approved_by [String, nil] - # # - # def initialize(approved_at:, approved_by:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(approved_at:, approved_by:) + # If your account requires approvals for transfers and the transfer was approved, + # this will contain details of the approval. + # + # @param approved_at [Time] + # @param approved_by [String, nil] end # @see Increase::Models::CheckTransfer#cancellation @@ -261,16 +226,12 @@ class Cancellation < Increase::Internal::Type::BaseModel # @return [String, nil] required :canceled_by, String, nil?: true - # @!parse - # # If your account requires approvals for transfers and the transfer was not - # # approved, this will contain details of the cancellation. - # # - # # @param canceled_at [Time] - # # @param canceled_by [String, nil] - # # - # def initialize(canceled_at:, canceled_by:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(canceled_at:, canceled_by:) + # If your account requires approvals for transfers and the transfer was not + # approved, this will contain details of the cancellation. + # + # @param canceled_at [Time] + # @param canceled_by [String, nil] end # @see Increase::Models::CheckTransfer#created_by @@ -301,17 +262,13 @@ class CreatedBy < Increase::Internal::Type::BaseModel # @return [Increase::Models::CheckTransfer::CreatedBy::User, nil] required :user, -> { Increase::Models::CheckTransfer::CreatedBy::User }, nil?: true - # @!parse - # # What object created the transfer, either via the API or the dashboard. - # # - # # @param api_key [Increase::Models::CheckTransfer::CreatedBy::APIKey, nil] - # # @param category [Symbol, Increase::Models::CheckTransfer::CreatedBy::Category] - # # @param oauth_application [Increase::Models::CheckTransfer::CreatedBy::OAuthApplication, nil] - # # @param user [Increase::Models::CheckTransfer::CreatedBy::User, nil] - # # - # def initialize(api_key:, category:, oauth_application:, user:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(api_key:, category:, oauth_application:, user:) + # What object created the transfer, either via the API or the dashboard. + # + # @param api_key [Increase::Models::CheckTransfer::CreatedBy::APIKey, nil] + # @param category [Symbol, Increase::Models::CheckTransfer::CreatedBy::Category] + # @param oauth_application [Increase::Models::CheckTransfer::CreatedBy::OAuthApplication, nil] + # @param user [Increase::Models::CheckTransfer::CreatedBy::User, nil] # @see Increase::Models::CheckTransfer::CreatedBy#api_key class APIKey < Increase::Internal::Type::BaseModel @@ -321,14 +278,10 @@ class APIKey < Increase::Internal::Type::BaseModel # @return [String, nil] required :description, String, nil?: true - # @!parse - # # If present, details about the API key that created the transfer. - # # - # # @param description [String, nil] - # # - # def initialize(description:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(description:) + # If present, details about the API key that created the transfer. + # + # @param description [String, nil] end # The type of object that created this transfer. @@ -346,11 +299,8 @@ module Category # A User in the Increase dashboard. Details will be under the `user` object. USER = :user - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Increase::Models::CheckTransfer::CreatedBy#oauth_application @@ -361,14 +311,10 @@ class OAuthApplication < Increase::Internal::Type::BaseModel # @return [String] required :name, String - # @!parse - # # If present, details about the OAuth Application that created the transfer. - # # - # # @param name [String] - # # - # def initialize(name:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(name:) + # If present, details about the OAuth Application that created the transfer. + # + # @param name [String] end # @see Increase::Models::CheckTransfer::CreatedBy#user @@ -379,14 +325,10 @@ class User < Increase::Internal::Type::BaseModel # @return [String] required :email, String - # @!parse - # # If present, details about the User that created the transfer. - # # - # # @param email [String] - # # - # def initialize(email:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(email:) + # If present, details about the User that created the transfer. + # + # @param email [String] end end @@ -415,11 +357,8 @@ module Currency # US Dollar (USD) USD = :USD - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # Whether Increase will print and mail the check or if you will do it yourself. @@ -434,11 +373,8 @@ module FulfillmentMethod # Increase will not print a check; you are responsible for printing and mailing a check with the provided account number, routing number, check number, and amount. THIRD_PARTY = :third_party - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Increase::Models::CheckTransfer#mailing @@ -463,17 +399,13 @@ class Mailing < Increase::Internal::Type::BaseModel # @return [String, nil] required :tracking_number, String, nil?: true - # @!parse - # # If the check has been mailed by Increase, this will contain details of the - # # shipment. - # # - # # @param image_id [String, nil] - # # @param mailed_at [Time] - # # @param tracking_number [String, nil] - # # - # def initialize(image_id:, mailed_at:, tracking_number:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(image_id:, mailed_at:, tracking_number:) + # If the check has been mailed by Increase, this will contain details of the + # shipment. + # + # @param image_id [String, nil] + # @param mailed_at [Time] + # @param tracking_number [String, nil] end # @see Increase::Models::CheckTransfer#physical_check @@ -536,36 +468,19 @@ class PhysicalCheck < Increase::Internal::Type::BaseModel required :tracking_updates, -> { Increase::Internal::Type::ArrayOf[Increase::Models::CheckTransfer::PhysicalCheck::TrackingUpdate] } - # @!parse - # # Details relating to the physical check that Increase will print and mail. Will - # # be present if and only if `fulfillment_method` is equal to `physical_check`. - # # - # # @param attachment_file_id [String, nil] - # # @param mailing_address [Increase::Models::CheckTransfer::PhysicalCheck::MailingAddress] - # # @param memo [String, nil] - # # @param note [String, nil] - # # @param recipient_name [String] - # # @param return_address [Increase::Models::CheckTransfer::PhysicalCheck::ReturnAddress, nil] - # # @param shipping_method [Symbol, Increase::Models::CheckTransfer::PhysicalCheck::ShippingMethod, nil] - # # @param signature_text [String, nil] - # # @param tracking_updates [Array] - # # - # def initialize( - # attachment_file_id:, - # mailing_address:, - # memo:, - # note:, - # recipient_name:, - # return_address:, - # shipping_method:, - # signature_text:, - # tracking_updates:, - # ** - # ) - # super - # end - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(attachment_file_id:, mailing_address:, memo:, note:, recipient_name:, return_address:, shipping_method:, signature_text:, tracking_updates:) + # Details relating to the physical check that Increase will print and mail. Will + # be present if and only if `fulfillment_method` is equal to `physical_check`. + # + # @param attachment_file_id [String, nil] + # @param mailing_address [Increase::Models::CheckTransfer::PhysicalCheck::MailingAddress] + # @param memo [String, nil] + # @param note [String, nil] + # @param recipient_name [String] + # @param return_address [Increase::Models::CheckTransfer::PhysicalCheck::ReturnAddress, nil] + # @param shipping_method [Symbol, Increase::Models::CheckTransfer::PhysicalCheck::ShippingMethod, nil] + # @param signature_text [String, nil] + # @param tracking_updates [Array] # @see Increase::Models::CheckTransfer::PhysicalCheck#mailing_address class MailingAddress < Increase::Internal::Type::BaseModel @@ -605,19 +520,15 @@ class MailingAddress < Increase::Internal::Type::BaseModel # @return [String, nil] required :state, String, nil?: true - # @!parse - # # Details for where Increase will mail the check. - # # - # # @param city [String, nil] - # # @param line1 [String, nil] - # # @param line2 [String, nil] - # # @param name [String, nil] - # # @param postal_code [String, nil] - # # @param state [String, nil] - # # - # def initialize(city:, line1:, line2:, name:, postal_code:, state:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(city:, line1:, line2:, name:, postal_code:, state:) + # Details for where Increase will mail the check. + # + # @param city [String, nil] + # @param line1 [String, nil] + # @param line2 [String, nil] + # @param name [String, nil] + # @param postal_code [String, nil] + # @param state [String, nil] end # @see Increase::Models::CheckTransfer::PhysicalCheck#return_address @@ -658,19 +569,15 @@ class ReturnAddress < Increase::Internal::Type::BaseModel # @return [String, nil] required :state, String, nil?: true - # @!parse - # # The return address to be printed on the check. - # # - # # @param city [String, nil] - # # @param line1 [String, nil] - # # @param line2 [String, nil] - # # @param name [String, nil] - # # @param postal_code [String, nil] - # # @param state [String, nil] - # # - # def initialize(city:, line1:, line2:, name:, postal_code:, state:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(city:, line1:, line2:, name:, postal_code:, state:) + # The return address to be printed on the check. + # + # @param city [String, nil] + # @param line1 [String, nil] + # @param line2 [String, nil] + # @param name [String, nil] + # @param postal_code [String, nil] + # @param state [String, nil] end # The shipping method for the check. @@ -685,11 +592,8 @@ module ShippingMethod # FedEx Overnight FEDEX_OVERNIGHT = :fedex_overnight - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end class TrackingUpdate < Increase::Internal::Type::BaseModel @@ -712,14 +616,10 @@ class TrackingUpdate < Increase::Internal::Type::BaseModel # @return [String] required :postal_code, String - # @!parse - # # @param category [Symbol, Increase::Models::CheckTransfer::PhysicalCheck::TrackingUpdate::Category] - # # @param created_at [Time] - # # @param postal_code [String] - # # - # def initialize(category:, created_at:, postal_code:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(category:, created_at:, postal_code:) + # @param category [Symbol, Increase::Models::CheckTransfer::PhysicalCheck::TrackingUpdate::Category] + # @param created_at [Time] + # @param postal_code [String] # The type of tracking event. # @@ -739,11 +639,8 @@ module Category # Delivery failed and the check was returned to sender. RETURNED_TO_SENDER = :returned_to_sender - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -784,11 +681,8 @@ module Status # The transfer has been returned. RETURNED = :returned - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Increase::Models::CheckTransfer#stop_payment_request @@ -818,18 +712,14 @@ class StopPaymentRequest < Increase::Internal::Type::BaseModel # @return [Symbol, Increase::Models::CheckTransfer::StopPaymentRequest::Type] required :type, enum: -> { Increase::Models::CheckTransfer::StopPaymentRequest::Type } - # @!parse - # # After a stop-payment is requested on the check, this will contain supplemental - # # details. - # # - # # @param reason [Symbol, Increase::Models::CheckTransfer::StopPaymentRequest::Reason] - # # @param requested_at [Time] - # # @param transfer_id [String] - # # @param type [Symbol, Increase::Models::CheckTransfer::StopPaymentRequest::Type] - # # - # def initialize(reason:, requested_at:, transfer_id:, type:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(reason:, requested_at:, transfer_id:, type:) + # After a stop-payment is requested on the check, this will contain supplemental + # details. + # + # @param reason [Symbol, Increase::Models::CheckTransfer::StopPaymentRequest::Reason] + # @param requested_at [Time] + # @param transfer_id [String] + # @param type [Symbol, Increase::Models::CheckTransfer::StopPaymentRequest::Type] # The reason why this transfer was stopped. # @@ -849,11 +739,8 @@ module Reason # The check was stopped for another reason. UNKNOWN = :unknown - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # A constant representing the object's type. For this resource it will always be @@ -865,11 +752,8 @@ module Type CHECK_TRANSFER_STOP_PAYMENT_REQUEST = :check_transfer_stop_payment_request - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -898,16 +782,12 @@ class Submission < Increase::Internal::Type::BaseModel # @return [Time] required :submitted_at, Time - # @!parse - # # After the transfer is submitted, this will contain supplemental details. - # # - # # @param address_correction_action [Symbol, Increase::Models::CheckTransfer::Submission::AddressCorrectionAction] - # # @param submitted_address [Increase::Models::CheckTransfer::Submission::SubmittedAddress] - # # @param submitted_at [Time] - # # - # def initialize(address_correction_action:, submitted_address:, submitted_at:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(address_correction_action:, submitted_address:, submitted_at:) + # After the transfer is submitted, this will contain supplemental details. + # + # @param address_correction_action [Symbol, Increase::Models::CheckTransfer::Submission::AddressCorrectionAction] + # @param submitted_address [Increase::Models::CheckTransfer::Submission::SubmittedAddress] + # @param submitted_at [Time] # Per USPS requirements, Increase will standardize the address to USPS standards # and check it against the USPS National Change of Address (NCOA) database before @@ -930,11 +810,8 @@ module AddressCorrectionAction # An error occurred while correcting the address. This typically means the USPS could not find that address. The address was not changed. ERROR = :error - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Increase::Models::CheckTransfer::Submission#submitted_address @@ -975,20 +852,16 @@ class SubmittedAddress < Increase::Internal::Type::BaseModel # @return [String] required :zip, String - # @!parse - # # The address we submitted to the printer. This is what is physically printed on - # # the check. - # # - # # @param city [String] - # # @param line1 [String] - # # @param line2 [String, nil] - # # @param recipient_name [String] - # # @param state [String] - # # @param zip [String] - # # - # def initialize(city:, line1:, line2:, recipient_name:, state:, zip:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(city:, line1:, line2:, recipient_name:, state:, zip:) + # The address we submitted to the printer. This is what is physically printed on + # the check. + # + # @param city [String] + # @param line1 [String] + # @param line2 [String, nil] + # @param recipient_name [String] + # @param state [String] + # @param zip [String] end end @@ -1000,15 +873,11 @@ class ThirdParty < Increase::Internal::Type::BaseModel # @return [String, nil] required :recipient_name, String, nil?: true - # @!parse - # # Details relating to the custom fulfillment you will perform. Will be present if - # # and only if `fulfillment_method` is equal to `third_party`. - # # - # # @param recipient_name [String, nil] - # # - # def initialize(recipient_name:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(recipient_name:) + # Details relating to the custom fulfillment you will perform. Will be present if + # and only if `fulfillment_method` is equal to `third_party`. + # + # @param recipient_name [String, nil] end # A constant representing the object's type. For this resource it will always be @@ -1020,11 +889,8 @@ module Type CHECK_TRANSFER = :check_transfer - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end diff --git a/lib/increase/models/check_transfer_approve_params.rb b/lib/increase/models/check_transfer_approve_params.rb index 9ea794070..d980d1224 100644 --- a/lib/increase/models/check_transfer_approve_params.rb +++ b/lib/increase/models/check_transfer_approve_params.rb @@ -4,16 +4,11 @@ module Increase module Models # @see Increase::Resources::CheckTransfers#approve class CheckTransferApproveParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters - # @!parse - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(request_options: {}, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(request_options: {}) + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/increase/models/check_transfer_cancel_params.rb b/lib/increase/models/check_transfer_cancel_params.rb index 3cd524f44..c0cb3527c 100644 --- a/lib/increase/models/check_transfer_cancel_params.rb +++ b/lib/increase/models/check_transfer_cancel_params.rb @@ -4,16 +4,11 @@ module Increase module Models # @see Increase::Resources::CheckTransfers#cancel class CheckTransferCancelParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters - # @!parse - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(request_options: {}, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(request_options: {}) + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/increase/models/check_transfer_create_params.rb b/lib/increase/models/check_transfer_create_params.rb index b8de2b49a..d724b8ad8 100644 --- a/lib/increase/models/check_transfer_create_params.rb +++ b/lib/increase/models/check_transfer_create_params.rb @@ -4,8 +4,7 @@ module Increase module Models # @see Increase::Resources::CheckTransfers#create class CheckTransferCreateParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters # @!attribute account_id @@ -33,7 +32,7 @@ class CheckTransferCreateParams < Increase::Internal::Type::BaseModel # @return [String] required :source_account_number_id, String - # @!attribute [r] physical_check + # @!attribute physical_check # Details relating to the physical check that Increase will print and mail. This # is required if `fulfillment_method` is equal to `physical_check`. It must not be # included if any other `fulfillment_method` is provided. @@ -41,21 +40,13 @@ class CheckTransferCreateParams < Increase::Internal::Type::BaseModel # @return [Increase::Models::CheckTransferCreateParams::PhysicalCheck, nil] optional :physical_check, -> { Increase::Models::CheckTransferCreateParams::PhysicalCheck } - # @!parse - # # @return [Increase::Models::CheckTransferCreateParams::PhysicalCheck] - # attr_writer :physical_check - - # @!attribute [r] require_approval + # @!attribute require_approval # Whether the transfer requires explicit approval via the dashboard or API. # # @return [Boolean, nil] optional :require_approval, Increase::Internal::Type::Boolean - # @!parse - # # @return [Boolean] - # attr_writer :require_approval - - # @!attribute [r] third_party + # @!attribute third_party # Details relating to the custom fulfillment you will perform. This is required if # `fulfillment_method` is equal to `third_party`. It must not be included if any # other `fulfillment_method` is provided. @@ -63,35 +54,15 @@ class CheckTransferCreateParams < Increase::Internal::Type::BaseModel # @return [Increase::Models::CheckTransferCreateParams::ThirdParty, nil] optional :third_party, -> { Increase::Models::CheckTransferCreateParams::ThirdParty } - # @!parse - # # @return [Increase::Models::CheckTransferCreateParams::ThirdParty] - # attr_writer :third_party - - # @!parse - # # @param account_id [String] - # # @param amount [Integer] - # # @param fulfillment_method [Symbol, Increase::Models::CheckTransferCreateParams::FulfillmentMethod] - # # @param source_account_number_id [String] - # # @param physical_check [Increase::Models::CheckTransferCreateParams::PhysicalCheck] - # # @param require_approval [Boolean] - # # @param third_party [Increase::Models::CheckTransferCreateParams::ThirdParty] - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize( - # account_id:, - # amount:, - # fulfillment_method:, - # source_account_number_id:, - # physical_check: nil, - # require_approval: nil, - # third_party: nil, - # request_options: {}, - # ** - # ) - # super - # end - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(account_id:, amount:, fulfillment_method:, source_account_number_id:, physical_check: nil, require_approval: nil, third_party: nil, request_options: {}) + # @param account_id [String] + # @param amount [Integer] + # @param fulfillment_method [Symbol, Increase::Models::CheckTransferCreateParams::FulfillmentMethod] + # @param source_account_number_id [String] + # @param physical_check [Increase::Models::CheckTransferCreateParams::PhysicalCheck] + # @param require_approval [Boolean] + # @param third_party [Increase::Models::CheckTransferCreateParams::ThirdParty] + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] # Whether Increase will print and mail the check or if you will do it yourself. module FulfillmentMethod @@ -103,11 +74,8 @@ module FulfillmentMethod # Increase will not print a check; you are responsible for printing and mailing a check with the provided account number, routing number, check number, and amount. THIRD_PARTY = :third_party - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end class PhysicalCheck < Increase::Internal::Type::BaseModel @@ -130,7 +98,7 @@ class PhysicalCheck < Increase::Internal::Type::BaseModel # @return [String] required :recipient_name, String - # @!attribute [r] attachment_file_id + # @!attribute attachment_file_id # The ID of a File to be attached to the check. This must have # `purpose: check_attachment`. For details on pricing and restrictions, see # https://increase.com/documentation/originating-checks#printing-checks . @@ -138,11 +106,7 @@ class PhysicalCheck < Increase::Internal::Type::BaseModel # @return [String, nil] optional :attachment_file_id, String - # @!parse - # # @return [String] - # attr_writer :attachment_file_id - - # @!attribute [r] check_number + # @!attribute check_number # The check number Increase should print on the check. This should not contain # leading zeroes and must be unique across the `source_account_number`. If this is # omitted, Increase will generate a check number for you. @@ -150,21 +114,13 @@ class PhysicalCheck < Increase::Internal::Type::BaseModel # @return [String, nil] optional :check_number, String - # @!parse - # # @return [String] - # attr_writer :check_number - - # @!attribute [r] note + # @!attribute note # The descriptor that will be printed on the letter included with the check. # # @return [String, nil] optional :note, String - # @!parse - # # @return [String] - # attr_writer :note - - # @!attribute [r] return_address + # @!attribute return_address # The return address to be printed on the check. If omitted this will default to # an Increase-owned address that will mark checks as delivery failed and shred # them. @@ -172,11 +128,7 @@ class PhysicalCheck < Increase::Internal::Type::BaseModel # @return [Increase::Models::CheckTransferCreateParams::PhysicalCheck::ReturnAddress, nil] optional :return_address, -> { Increase::Models::CheckTransferCreateParams::PhysicalCheck::ReturnAddress } - # @!parse - # # @return [Increase::Models::CheckTransferCreateParams::PhysicalCheck::ReturnAddress] - # attr_writer :return_address - - # @!attribute [r] shipping_method + # @!attribute shipping_method # How to ship the check. For details on pricing, timing, and restrictions, see # https://increase.com/documentation/originating-checks#printing-checks . # @@ -184,52 +136,27 @@ class PhysicalCheck < Increase::Internal::Type::BaseModel optional :shipping_method, enum: -> { Increase::Models::CheckTransferCreateParams::PhysicalCheck::ShippingMethod } - # @!parse - # # @return [Symbol, Increase::Models::CheckTransferCreateParams::PhysicalCheck::ShippingMethod] - # attr_writer :shipping_method - - # @!attribute [r] signature_text + # @!attribute signature_text # The text that will appear as the signature on the check in cursive font. If not # provided, the check will be printed with 'No signature required'. # # @return [String, nil] optional :signature_text, String - # @!parse - # # @return [String] - # attr_writer :signature_text - - # @!parse - # # Details relating to the physical check that Increase will print and mail. This - # # is required if `fulfillment_method` is equal to `physical_check`. It must not be - # # included if any other `fulfillment_method` is provided. - # # - # # @param mailing_address [Increase::Models::CheckTransferCreateParams::PhysicalCheck::MailingAddress] - # # @param memo [String] - # # @param recipient_name [String] - # # @param attachment_file_id [String] - # # @param check_number [String] - # # @param note [String] - # # @param return_address [Increase::Models::CheckTransferCreateParams::PhysicalCheck::ReturnAddress] - # # @param shipping_method [Symbol, Increase::Models::CheckTransferCreateParams::PhysicalCheck::ShippingMethod] - # # @param signature_text [String] - # # - # def initialize( - # mailing_address:, - # memo:, - # recipient_name:, - # attachment_file_id: nil, - # check_number: nil, - # note: nil, - # return_address: nil, - # shipping_method: nil, - # signature_text: nil, - # ** - # ) - # super - # end - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(mailing_address:, memo:, recipient_name:, attachment_file_id: nil, check_number: nil, note: nil, return_address: nil, shipping_method: nil, signature_text: nil) + # Details relating to the physical check that Increase will print and mail. This + # is required if `fulfillment_method` is equal to `physical_check`. It must not be + # included if any other `fulfillment_method` is provided. + # + # @param mailing_address [Increase::Models::CheckTransferCreateParams::PhysicalCheck::MailingAddress] + # @param memo [String] + # @param recipient_name [String] + # @param attachment_file_id [String] + # @param check_number [String] + # @param note [String] + # @param return_address [Increase::Models::CheckTransferCreateParams::PhysicalCheck::ReturnAddress] + # @param shipping_method [Symbol, Increase::Models::CheckTransferCreateParams::PhysicalCheck::ShippingMethod] + # @param signature_text [String] # @see Increase::Models::CheckTransferCreateParams::PhysicalCheck#mailing_address class MailingAddress < Increase::Internal::Type::BaseModel @@ -257,28 +184,20 @@ class MailingAddress < Increase::Internal::Type::BaseModel # @return [String] required :state, String - # @!attribute [r] line2 + # @!attribute line2 # The second line of the address component of the check's destination address. # # @return [String, nil] optional :line2, String - # @!parse - # # @return [String] - # attr_writer :line2 - - # @!parse - # # Details for where Increase will mail the check. - # # - # # @param city [String] - # # @param line1 [String] - # # @param postal_code [String] - # # @param state [String] - # # @param line2 [String] - # # - # def initialize(city:, line1:, postal_code:, state:, line2: nil, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(city:, line1:, postal_code:, state:, line2: nil) + # Details for where Increase will mail the check. + # + # @param city [String] + # @param line1 [String] + # @param postal_code [String] + # @param state [String] + # @param line2 [String] end # @see Increase::Models::CheckTransferCreateParams::PhysicalCheck#return_address @@ -313,31 +232,23 @@ class ReturnAddress < Increase::Internal::Type::BaseModel # @return [String] required :state, String - # @!attribute [r] line2 + # @!attribute line2 # The second line of the return address. # # @return [String, nil] optional :line2, String - # @!parse - # # @return [String] - # attr_writer :line2 - - # @!parse - # # The return address to be printed on the check. If omitted this will default to - # # an Increase-owned address that will mark checks as delivery failed and shred - # # them. - # # - # # @param city [String] - # # @param line1 [String] - # # @param name [String] - # # @param postal_code [String] - # # @param state [String] - # # @param line2 [String] - # # - # def initialize(city:, line1:, name:, postal_code:, state:, line2: nil, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(city:, line1:, name:, postal_code:, state:, line2: nil) + # The return address to be printed on the check. If omitted this will default to + # an Increase-owned address that will mark checks as delivery failed and shred + # them. + # + # @param city [String] + # @param line1 [String] + # @param name [String] + # @param postal_code [String] + # @param state [String] + # @param line2 [String] end # How to ship the check. For details on pricing, timing, and restrictions, see @@ -353,16 +264,13 @@ module ShippingMethod # FedEx Overnight FEDEX_OVERNIGHT = :fedex_overnight - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end class ThirdParty < Increase::Internal::Type::BaseModel - # @!attribute [r] recipient_name + # @!attribute recipient_name # The pay-to name you will print on the check. If provided, this is used for # [Positive Pay](/documentation/positive-pay). If this is omitted, Increase will # be unable to validate the payee name when the check is deposited. @@ -370,20 +278,12 @@ class ThirdParty < Increase::Internal::Type::BaseModel # @return [String, nil] optional :recipient_name, String - # @!parse - # # @return [String] - # attr_writer :recipient_name - - # @!parse - # # Details relating to the custom fulfillment you will perform. This is required if - # # `fulfillment_method` is equal to `third_party`. It must not be included if any - # # other `fulfillment_method` is provided. - # # - # # @param recipient_name [String] - # # - # def initialize(recipient_name: nil, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(recipient_name: nil) + # Details relating to the custom fulfillment you will perform. This is required if + # `fulfillment_method` is equal to `third_party`. It must not be included if any + # other `fulfillment_method` is provided. + # + # @param recipient_name [String] end end end diff --git a/lib/increase/models/check_transfer_list_params.rb b/lib/increase/models/check_transfer_list_params.rb index da3493c3a..cb4248bcc 100644 --- a/lib/increase/models/check_transfer_list_params.rb +++ b/lib/increase/models/check_transfer_list_params.rb @@ -4,40 +4,27 @@ module Increase module Models # @see Increase::Resources::CheckTransfers#list class CheckTransferListParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters - # @!attribute [r] account_id + # @!attribute account_id # Filter Check Transfers to those that originated from the specified Account. # # @return [String, nil] optional :account_id, String - # @!parse - # # @return [String] - # attr_writer :account_id - - # @!attribute [r] created_at + # @!attribute created_at # # @return [Increase::Models::CheckTransferListParams::CreatedAt, nil] optional :created_at, -> { Increase::Models::CheckTransferListParams::CreatedAt } - # @!parse - # # @return [Increase::Models::CheckTransferListParams::CreatedAt] - # attr_writer :created_at - - # @!attribute [r] cursor + # @!attribute cursor # Return the page of entries after this one. # # @return [String, nil] optional :cursor, String - # @!parse - # # @return [String] - # attr_writer :cursor - - # @!attribute [r] idempotency_key + # @!attribute idempotency_key # Filter records to the one with the specified `idempotency_key` you chose for # that object. This value is unique across Increase and is used to ensure that a # request is only processed once. Learn more about @@ -46,112 +33,65 @@ class CheckTransferListParams < Increase::Internal::Type::BaseModel # @return [String, nil] optional :idempotency_key, String - # @!parse - # # @return [String] - # attr_writer :idempotency_key - - # @!attribute [r] limit + # @!attribute limit # Limit the size of the list that is returned. The default (and maximum) is 100 # objects. # # @return [Integer, nil] optional :limit, Integer - # @!parse - # # @return [Integer] - # attr_writer :limit - - # @!attribute [r] status + # @!attribute status # # @return [Increase::Models::CheckTransferListParams::Status, nil] optional :status, -> { Increase::Models::CheckTransferListParams::Status } - # @!parse - # # @return [Increase::Models::CheckTransferListParams::Status] - # attr_writer :status - - # @!parse - # # @param account_id [String] - # # @param created_at [Increase::Models::CheckTransferListParams::CreatedAt] - # # @param cursor [String] - # # @param idempotency_key [String] - # # @param limit [Integer] - # # @param status [Increase::Models::CheckTransferListParams::Status] - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize( - # account_id: nil, - # created_at: nil, - # cursor: nil, - # idempotency_key: nil, - # limit: nil, - # status: nil, - # request_options: {}, - # ** - # ) - # super - # end - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(account_id: nil, created_at: nil, cursor: nil, idempotency_key: nil, limit: nil, status: nil, request_options: {}) + # @param account_id [String] + # @param created_at [Increase::Models::CheckTransferListParams::CreatedAt] + # @param cursor [String] + # @param idempotency_key [String] + # @param limit [Integer] + # @param status [Increase::Models::CheckTransferListParams::Status] + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] class CreatedAt < Increase::Internal::Type::BaseModel - # @!attribute [r] after + # @!attribute after # Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) # timestamp. # # @return [Time, nil] optional :after, Time - # @!parse - # # @return [Time] - # attr_writer :after - - # @!attribute [r] before + # @!attribute before # Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) # timestamp. # # @return [Time, nil] optional :before, Time - # @!parse - # # @return [Time] - # attr_writer :before - - # @!attribute [r] on_or_after + # @!attribute on_or_after # Return results on or after this # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. # # @return [Time, nil] optional :on_or_after, Time - # @!parse - # # @return [Time] - # attr_writer :on_or_after - - # @!attribute [r] on_or_before + # @!attribute on_or_before # Return results on or before this # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. # # @return [Time, nil] optional :on_or_before, Time - # @!parse - # # @return [Time] - # attr_writer :on_or_before - - # @!parse - # # @param after [Time] - # # @param before [Time] - # # @param on_or_after [Time] - # # @param on_or_before [Time] - # # - # def initialize(after: nil, before: nil, on_or_after: nil, on_or_before: nil, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(after: nil, before: nil, on_or_after: nil, on_or_before: nil) + # @param after [Time] + # @param before [Time] + # @param on_or_after [Time] + # @param on_or_before [Time] end class Status < Increase::Internal::Type::BaseModel - # @!attribute [r] in_ + # @!attribute in_ # Filter Check Transfers to those that have the specified status. For GET # requests, this should be encoded as a comma-delimited string, such as # `?in=one,two,three`. @@ -161,16 +101,8 @@ class Status < Increase::Internal::Type::BaseModel -> { Increase::Internal::Type::ArrayOf[enum: Increase::Models::CheckTransferListParams::Status::In] }, api_name: :in - # @!parse - # # @return [Array] - # attr_writer :in_ - - # @!parse - # # @param in_ [Array] - # # - # def initialize(in_: nil, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(in_: nil) + # @param in_ [Array] module In extend Increase::Internal::Type::Enum @@ -205,11 +137,8 @@ module In # The transfer has been returned. RETURNED = :returned - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end diff --git a/lib/increase/models/check_transfer_retrieve_params.rb b/lib/increase/models/check_transfer_retrieve_params.rb index 83824902d..af373f79e 100644 --- a/lib/increase/models/check_transfer_retrieve_params.rb +++ b/lib/increase/models/check_transfer_retrieve_params.rb @@ -4,16 +4,11 @@ module Increase module Models # @see Increase::Resources::CheckTransfers#retrieve class CheckTransferRetrieveParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters - # @!parse - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(request_options: {}, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(request_options: {}) + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/increase/models/check_transfer_stop_payment_params.rb b/lib/increase/models/check_transfer_stop_payment_params.rb index c2894cfe4..0fab9d42a 100644 --- a/lib/increase/models/check_transfer_stop_payment_params.rb +++ b/lib/increase/models/check_transfer_stop_payment_params.rb @@ -4,27 +4,18 @@ module Increase module Models # @see Increase::Resources::CheckTransfers#stop_payment class CheckTransferStopPaymentParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters - # @!attribute [r] reason + # @!attribute reason # The reason why this transfer should be stopped. # # @return [Symbol, Increase::Models::CheckTransferStopPaymentParams::Reason, nil] optional :reason, enum: -> { Increase::Models::CheckTransferStopPaymentParams::Reason } - # @!parse - # # @return [Symbol, Increase::Models::CheckTransferStopPaymentParams::Reason] - # attr_writer :reason - - # @!parse - # # @param reason [Symbol, Increase::Models::CheckTransferStopPaymentParams::Reason] - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(reason: nil, request_options: {}, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(reason: nil, request_options: {}) + # @param reason [Symbol, Increase::Models::CheckTransferStopPaymentParams::Reason] + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] # The reason why this transfer should be stopped. module Reason @@ -39,11 +30,8 @@ module Reason # The check was stopped for another reason. UNKNOWN = :unknown - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end diff --git a/lib/increase/models/declined_transaction.rb b/lib/increase/models/declined_transaction.rb index 566da4bca..8ce0f278f 100644 --- a/lib/increase/models/declined_transaction.rb +++ b/lib/increase/models/declined_transaction.rb @@ -74,39 +74,21 @@ class DeclinedTransaction < Increase::Internal::Type::BaseModel # @return [Symbol, Increase::Models::DeclinedTransaction::Type] required :type, enum: -> { Increase::Models::DeclinedTransaction::Type } - # @!parse - # # Declined Transactions are refused additions and removals of money from your bank - # # account. For example, Declined Transactions are caused when your Account has an - # # insufficient balance or your Limits are triggered. - # # - # # @param id [String] - # # @param account_id [String] - # # @param amount [Integer] - # # @param created_at [Time] - # # @param currency [Symbol, Increase::Models::DeclinedTransaction::Currency] - # # @param description [String] - # # @param route_id [String, nil] - # # @param route_type [Symbol, Increase::Models::DeclinedTransaction::RouteType, nil] - # # @param source [Increase::Models::DeclinedTransaction::Source] - # # @param type [Symbol, Increase::Models::DeclinedTransaction::Type] - # # - # def initialize( - # id:, - # account_id:, - # amount:, - # created_at:, - # currency:, - # description:, - # route_id:, - # route_type:, - # source:, - # type:, - # ** - # ) - # super - # end - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(id:, account_id:, amount:, created_at:, currency:, description:, route_id:, route_type:, source:, type:) + # Declined Transactions are refused additions and removals of money from your bank + # account. For example, Declined Transactions are caused when your Account has an + # insufficient balance or your Limits are triggered. + # + # @param id [String] + # @param account_id [String] + # @param amount [Integer] + # @param created_at [Time] + # @param currency [Symbol, Increase::Models::DeclinedTransaction::Currency] + # @param description [String] + # @param route_id [String, nil] + # @param route_type [Symbol, Increase::Models::DeclinedTransaction::RouteType, nil] + # @param source [Increase::Models::DeclinedTransaction::Source] + # @param type [Symbol, Increase::Models::DeclinedTransaction::Type] # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the Declined # Transaction's currency. This will match the currency on the Declined @@ -134,11 +116,8 @@ module Currency # US Dollar (USD) USD = :USD - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # The type of the route this Declined Transaction came through. @@ -156,11 +135,8 @@ module RouteType # A Lockbox. LOCKBOX = :lockbox - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Increase::Models::DeclinedTransaction#source @@ -226,37 +202,21 @@ class Source < Increase::Internal::Type::BaseModel # @return [Increase::Models::DeclinedTransaction::Source::WireDecline, nil] required :wire_decline, -> { Increase::Models::DeclinedTransaction::Source::WireDecline }, nil?: true - # @!parse - # # This is an object giving more details on the network-level event that caused the - # # Declined Transaction. For example, for a card transaction this lists the - # # merchant's industry and location. Note that for backwards compatibility reasons, - # # additional undocumented keys may appear in this object. These should be treated - # # as deprecated and will be removed in the future. - # # - # # @param ach_decline [Increase::Models::DeclinedTransaction::Source::ACHDecline, nil] - # # @param card_decline [Increase::Models::DeclinedTransaction::Source::CardDecline, nil] - # # @param category [Symbol, Increase::Models::DeclinedTransaction::Source::Category] - # # @param check_decline [Increase::Models::DeclinedTransaction::Source::CheckDecline, nil] - # # @param check_deposit_rejection [Increase::Models::DeclinedTransaction::Source::CheckDepositRejection, nil] - # # @param inbound_real_time_payments_transfer_decline [Increase::Models::DeclinedTransaction::Source::InboundRealTimePaymentsTransferDecline, nil] - # # @param other [Object, nil] - # # @param wire_decline [Increase::Models::DeclinedTransaction::Source::WireDecline, nil] - # # - # def initialize( - # ach_decline:, - # card_decline:, - # category:, - # check_decline:, - # check_deposit_rejection:, - # inbound_real_time_payments_transfer_decline:, - # other:, - # wire_decline:, - # ** - # ) - # super - # end - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(ach_decline:, card_decline:, category:, check_decline:, check_deposit_rejection:, inbound_real_time_payments_transfer_decline:, other:, wire_decline:) + # This is an object giving more details on the network-level event that caused the + # Declined Transaction. For example, for a card transaction this lists the + # merchant's industry and location. Note that for backwards compatibility reasons, + # additional undocumented keys may appear in this object. These should be treated + # as deprecated and will be removed in the future. + # + # @param ach_decline [Increase::Models::DeclinedTransaction::Source::ACHDecline, nil] + # @param card_decline [Increase::Models::DeclinedTransaction::Source::CardDecline, nil] + # @param category [Symbol, Increase::Models::DeclinedTransaction::Source::Category] + # @param check_decline [Increase::Models::DeclinedTransaction::Source::CheckDecline, nil] + # @param check_deposit_rejection [Increase::Models::DeclinedTransaction::Source::CheckDepositRejection, nil] + # @param inbound_real_time_payments_transfer_decline [Increase::Models::DeclinedTransaction::Source::InboundRealTimePaymentsTransferDecline, nil] + # @param other [Object, nil] + # @param wire_decline [Increase::Models::DeclinedTransaction::Source::WireDecline, nil] # @see Increase::Models::DeclinedTransaction::Source#ach_decline class ACHDecline < Increase::Internal::Type::BaseModel @@ -333,42 +293,22 @@ class ACHDecline < Increase::Internal::Type::BaseModel # @return [Symbol, Increase::Models::DeclinedTransaction::Source::ACHDecline::Type] required :type, enum: -> { Increase::Models::DeclinedTransaction::Source::ACHDecline::Type } - # @!parse - # # An ACH Decline object. This field will be present in the JSON response if and - # # only if `category` is equal to `ach_decline`. - # # - # # @param id [String] - # # @param amount [Integer] - # # @param inbound_ach_transfer_id [String] - # # @param originator_company_descriptive_date [String, nil] - # # @param originator_company_discretionary_data [String, nil] - # # @param originator_company_id [String] - # # @param originator_company_name [String] - # # @param reason [Symbol, Increase::Models::DeclinedTransaction::Source::ACHDecline::Reason] - # # @param receiver_id_number [String, nil] - # # @param receiver_name [String, nil] - # # @param trace_number [String] - # # @param type [Symbol, Increase::Models::DeclinedTransaction::Source::ACHDecline::Type] - # # - # def initialize( - # id:, - # amount:, - # inbound_ach_transfer_id:, - # originator_company_descriptive_date:, - # originator_company_discretionary_data:, - # originator_company_id:, - # originator_company_name:, - # reason:, - # receiver_id_number:, - # receiver_name:, - # trace_number:, - # type:, - # ** - # ) - # super - # end - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(id:, amount:, inbound_ach_transfer_id:, originator_company_descriptive_date:, originator_company_discretionary_data:, originator_company_id:, originator_company_name:, reason:, receiver_id_number:, receiver_name:, trace_number:, type:) + # An ACH Decline object. This field will be present in the JSON response if and + # only if `category` is equal to `ach_decline`. + # + # @param id [String] + # @param amount [Integer] + # @param inbound_ach_transfer_id [String] + # @param originator_company_descriptive_date [String, nil] + # @param originator_company_discretionary_data [String, nil] + # @param originator_company_id [String] + # @param originator_company_name [String] + # @param reason [Symbol, Increase::Models::DeclinedTransaction::Source::ACHDecline::Reason] + # @param receiver_id_number [String, nil] + # @param receiver_name [String, nil] + # @param trace_number [String] + # @param type [Symbol, Increase::Models::DeclinedTransaction::Source::ACHDecline::Type] # Why the ACH transfer was declined. # @@ -429,11 +369,8 @@ module Reason # The corporate customer no longer authorizes this transaction. CORPORATE_CUSTOMER_ADVISED_NOT_AUTHORIZED = :corporate_customer_advised_not_authorized - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # A constant representing the object's type. For this resource it will always be @@ -445,11 +382,8 @@ module Type ACH_DECLINE = :ach_decline - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -637,72 +571,37 @@ class CardDecline < Increase::Internal::Type::BaseModel # @return [Increase::Models::DeclinedTransaction::Source::CardDecline::Verification] required :verification, -> { Increase::Models::DeclinedTransaction::Source::CardDecline::Verification } - # @!parse - # # A Card Decline object. This field will be present in the JSON response if and - # # only if `category` is equal to `card_decline`. - # # - # # @param id [String] - # # @param actioner [Symbol, Increase::Models::DeclinedTransaction::Source::CardDecline::Actioner] - # # @param amount [Integer] - # # @param card_payment_id [String] - # # @param currency [Symbol, Increase::Models::DeclinedTransaction::Source::CardDecline::Currency] - # # @param declined_transaction_id [String] - # # @param digital_wallet_token_id [String, nil] - # # @param direction [Symbol, Increase::Models::DeclinedTransaction::Source::CardDecline::Direction] - # # @param merchant_acceptor_id [String] - # # @param merchant_category_code [String] - # # @param merchant_city [String, nil] - # # @param merchant_country [String] - # # @param merchant_descriptor [String] - # # @param merchant_postal_code [String, nil] - # # @param merchant_state [String, nil] - # # @param network_details [Increase::Models::DeclinedTransaction::Source::CardDecline::NetworkDetails] - # # @param network_identifiers [Increase::Models::DeclinedTransaction::Source::CardDecline::NetworkIdentifiers] - # # @param network_risk_score [Integer, nil] - # # @param physical_card_id [String, nil] - # # @param presentment_amount [Integer] - # # @param presentment_currency [String] - # # @param processing_category [Symbol, Increase::Models::DeclinedTransaction::Source::CardDecline::ProcessingCategory] - # # @param real_time_decision_id [String, nil] - # # @param real_time_decision_reason [Symbol, Increase::Models::DeclinedTransaction::Source::CardDecline::RealTimeDecisionReason, nil] - # # @param reason [Symbol, Increase::Models::DeclinedTransaction::Source::CardDecline::Reason] - # # @param terminal_id [String, nil] - # # @param verification [Increase::Models::DeclinedTransaction::Source::CardDecline::Verification] - # # - # def initialize( - # id:, - # actioner:, - # amount:, - # card_payment_id:, - # currency:, - # declined_transaction_id:, - # digital_wallet_token_id:, - # direction:, - # merchant_acceptor_id:, - # merchant_category_code:, - # merchant_city:, - # merchant_country:, - # merchant_descriptor:, - # merchant_postal_code:, - # merchant_state:, - # network_details:, - # network_identifiers:, - # network_risk_score:, - # physical_card_id:, - # presentment_amount:, - # presentment_currency:, - # processing_category:, - # real_time_decision_id:, - # real_time_decision_reason:, - # reason:, - # terminal_id:, - # verification:, - # ** - # ) - # super - # end - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(id:, actioner:, amount:, card_payment_id:, currency:, declined_transaction_id:, digital_wallet_token_id:, direction:, merchant_acceptor_id:, merchant_category_code:, merchant_city:, merchant_country:, merchant_descriptor:, merchant_postal_code:, merchant_state:, network_details:, network_identifiers:, network_risk_score:, physical_card_id:, presentment_amount:, presentment_currency:, processing_category:, real_time_decision_id:, real_time_decision_reason:, reason:, terminal_id:, verification:) + # A Card Decline object. This field will be present in the JSON response if and + # only if `category` is equal to `card_decline`. + # + # @param id [String] + # @param actioner [Symbol, Increase::Models::DeclinedTransaction::Source::CardDecline::Actioner] + # @param amount [Integer] + # @param card_payment_id [String] + # @param currency [Symbol, Increase::Models::DeclinedTransaction::Source::CardDecline::Currency] + # @param declined_transaction_id [String] + # @param digital_wallet_token_id [String, nil] + # @param direction [Symbol, Increase::Models::DeclinedTransaction::Source::CardDecline::Direction] + # @param merchant_acceptor_id [String] + # @param merchant_category_code [String] + # @param merchant_city [String, nil] + # @param merchant_country [String] + # @param merchant_descriptor [String] + # @param merchant_postal_code [String, nil] + # @param merchant_state [String, nil] + # @param network_details [Increase::Models::DeclinedTransaction::Source::CardDecline::NetworkDetails] + # @param network_identifiers [Increase::Models::DeclinedTransaction::Source::CardDecline::NetworkIdentifiers] + # @param network_risk_score [Integer, nil] + # @param physical_card_id [String, nil] + # @param presentment_amount [Integer] + # @param presentment_currency [String] + # @param processing_category [Symbol, Increase::Models::DeclinedTransaction::Source::CardDecline::ProcessingCategory] + # @param real_time_decision_id [String, nil] + # @param real_time_decision_reason [Symbol, Increase::Models::DeclinedTransaction::Source::CardDecline::RealTimeDecisionReason, nil] + # @param reason [Symbol, Increase::Models::DeclinedTransaction::Source::CardDecline::Reason] + # @param terminal_id [String, nil] + # @param verification [Increase::Models::DeclinedTransaction::Source::CardDecline::Verification] # Whether this authorization was approved by Increase, the card network through # stand-in processing, or the user through a real-time decision. @@ -720,11 +619,8 @@ module Actioner # This object was actioned by the network, through stand-in processing. NETWORK = :network - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the destination @@ -752,11 +648,8 @@ module Currency # US Dollar (USD) USD = :USD - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # The direction describes the direction the funds will move, either from the @@ -772,11 +665,8 @@ module Direction # A refund card authorization, sometimes referred to as a credit voucher authorization, where funds are credited to the cardholder. REFUND = :refund - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Increase::Models::DeclinedTransaction::Source::CardDecline#network_details @@ -796,15 +686,11 @@ class NetworkDetails < Increase::Internal::Type::BaseModel -> { Increase::Models::DeclinedTransaction::Source::CardDecline::NetworkDetails::Visa }, nil?: true - # @!parse - # # Fields specific to the `network`. - # # - # # @param category [Symbol, Increase::Models::DeclinedTransaction::Source::CardDecline::NetworkDetails::Category] - # # @param visa [Increase::Models::DeclinedTransaction::Source::CardDecline::NetworkDetails::Visa, nil] - # # - # def initialize(category:, visa:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(category:, visa:) + # Fields specific to the `network`. + # + # @param category [Symbol, Increase::Models::DeclinedTransaction::Source::CardDecline::NetworkDetails::Category] + # @param visa [Increase::Models::DeclinedTransaction::Source::CardDecline::NetworkDetails::Visa, nil] # The payment network used to process this card authorization. # @@ -815,11 +701,8 @@ module Category # Visa VISA = :visa - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Increase::Models::DeclinedTransaction::Source::CardDecline::NetworkDetails#visa @@ -852,16 +735,12 @@ class Visa < Increase::Internal::Type::BaseModel enum: -> { Increase::Models::DeclinedTransaction::Source::CardDecline::NetworkDetails::Visa::StandInProcessingReason }, nil?: true - # @!parse - # # Fields specific to the `visa` network. - # # - # # @param electronic_commerce_indicator [Symbol, Increase::Models::DeclinedTransaction::Source::CardDecline::NetworkDetails::Visa::ElectronicCommerceIndicator, nil] - # # @param point_of_service_entry_mode [Symbol, Increase::Models::DeclinedTransaction::Source::CardDecline::NetworkDetails::Visa::PointOfServiceEntryMode, nil] - # # @param stand_in_processing_reason [Symbol, Increase::Models::DeclinedTransaction::Source::CardDecline::NetworkDetails::Visa::StandInProcessingReason, nil] - # # - # def initialize(electronic_commerce_indicator:, point_of_service_entry_mode:, stand_in_processing_reason:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(electronic_commerce_indicator:, point_of_service_entry_mode:, stand_in_processing_reason:) + # Fields specific to the `visa` network. + # + # @param electronic_commerce_indicator [Symbol, Increase::Models::DeclinedTransaction::Source::CardDecline::NetworkDetails::Visa::ElectronicCommerceIndicator, nil] + # @param point_of_service_entry_mode [Symbol, Increase::Models::DeclinedTransaction::Source::CardDecline::NetworkDetails::Visa::PointOfServiceEntryMode, nil] + # @param stand_in_processing_reason [Symbol, Increase::Models::DeclinedTransaction::Source::CardDecline::NetworkDetails::Visa::StandInProcessingReason, nil] # For electronic commerce transactions, this identifies the level of security used # in obtaining the customer's payment credential. For mail or telephone order @@ -896,11 +775,8 @@ module ElectronicCommerceIndicator # Non-secure transaction: Use to identify an electronic commerce transaction that has no data protection. NON_SECURE_TRANSACTION = :non_secure_transaction - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # The method used to enter the cardholder's primary account number and card @@ -940,11 +816,8 @@ module PointOfServiceEntryMode # Contact chip card, without card verification value INTEGRATED_CIRCUIT_CARD_NO_CVV = :integrated_circuit_card_no_cvv - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # Only present when `actioner: network`. Describes why a card authorization was @@ -977,11 +850,8 @@ module StandInProcessingReason # An unspecific reason for stand-in processing. OTHER = :other - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -1010,16 +880,12 @@ class NetworkIdentifiers < Increase::Internal::Type::BaseModel # @return [String, nil] required :transaction_id, String, nil?: true - # @!parse - # # Network-specific identifiers for a specific request or transaction. - # # - # # @param retrieval_reference_number [String, nil] - # # @param trace_number [String, nil] - # # @param transaction_id [String, nil] - # # - # def initialize(retrieval_reference_number:, trace_number:, transaction_id:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(retrieval_reference_number:, trace_number:, transaction_id:) + # Network-specific identifiers for a specific request or transaction. + # + # @param retrieval_reference_number [String, nil] + # @param trace_number [String, nil] + # @param transaction_id [String, nil] end # The processing category describes the intent behind the authorization, such as @@ -1047,11 +913,8 @@ module ProcessingCategory # A refund card authorization, sometimes referred to as a credit voucher authorization, where funds are credited to the cardholder. REFUND = :refund - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # This is present if a specific decline reason was given in the real-time @@ -1079,11 +942,8 @@ module RealTimeDecisionReason # The transaction was declined for another reason. The merchant may attempt to process the transaction again. This should be used sparingly. OTHER = :other - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # Why the transaction was declined. @@ -1140,14 +1000,14 @@ module Reason # The original card authorization for this incremental authorization does not exist. MISSING_ORIGINAL_AUTHORIZATION = :missing_original_authorization + # The transaction was declined because the 3DS authentication failed. + FAILED_3DS_AUTHENTICATION = :failed_3ds_authentication + # The transaction was suspected to be fraudulent. Please reach out to support@increase.com for more information. SUSPECTED_FRAUD = :suspected_fraud - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Increase::Models::DeclinedTransaction::Source::CardDecline#verification @@ -1168,15 +1028,11 @@ class Verification < Increase::Internal::Type::BaseModel required :cardholder_address, -> { Increase::Models::DeclinedTransaction::Source::CardDecline::Verification::CardholderAddress } - # @!parse - # # Fields related to verification of cardholder-provided values. - # # - # # @param card_verification_code [Increase::Models::DeclinedTransaction::Source::CardDecline::Verification::CardVerificationCode] - # # @param cardholder_address [Increase::Models::DeclinedTransaction::Source::CardDecline::Verification::CardholderAddress] - # # - # def initialize(card_verification_code:, cardholder_address:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(card_verification_code:, cardholder_address:) + # Fields related to verification of cardholder-provided values. + # + # @param card_verification_code [Increase::Models::DeclinedTransaction::Source::CardDecline::Verification::CardVerificationCode] + # @param cardholder_address [Increase::Models::DeclinedTransaction::Source::CardDecline::Verification::CardholderAddress] # @see Increase::Models::DeclinedTransaction::Source::CardDecline::Verification#card_verification_code class CardVerificationCode < Increase::Internal::Type::BaseModel @@ -1187,15 +1043,11 @@ class CardVerificationCode < Increase::Internal::Type::BaseModel required :result, enum: -> { Increase::Models::DeclinedTransaction::Source::CardDecline::Verification::CardVerificationCode::Result } - # @!parse - # # Fields related to verification of the Card Verification Code, a 3-digit code on - # # the back of the card. - # # - # # @param result [Symbol, Increase::Models::DeclinedTransaction::Source::CardDecline::Verification::CardVerificationCode::Result] - # # - # def initialize(result:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(result:) + # Fields related to verification of the Card Verification Code, a 3-digit code on + # the back of the card. + # + # @param result [Symbol, Increase::Models::DeclinedTransaction::Source::CardDecline::Verification::CardVerificationCode::Result] # The result of verifying the Card Verification Code. # @@ -1212,11 +1064,8 @@ module Result # The card verification code did not match the one on file. NO_MATCH = :no_match - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -1254,19 +1103,15 @@ class CardholderAddress < Increase::Internal::Type::BaseModel required :result, enum: -> { Increase::Models::DeclinedTransaction::Source::CardDecline::Verification::CardholderAddress::Result } - # @!parse - # # Cardholder address provided in the authorization request and the address on file - # # we verified it against. - # # - # # @param actual_line1 [String, nil] - # # @param actual_postal_code [String, nil] - # # @param provided_line1 [String, nil] - # # @param provided_postal_code [String, nil] - # # @param result [Symbol, Increase::Models::DeclinedTransaction::Source::CardDecline::Verification::CardholderAddress::Result] - # # - # def initialize(actual_line1:, actual_postal_code:, provided_line1:, provided_postal_code:, result:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(actual_line1:, actual_postal_code:, provided_line1:, provided_postal_code:, result:) + # Cardholder address provided in the authorization request and the address on file + # we verified it against. + # + # @param actual_line1 [String, nil] + # @param actual_postal_code [String, nil] + # @param provided_line1 [String, nil] + # @param provided_postal_code [String, nil] + # @param result [Symbol, Increase::Models::DeclinedTransaction::Source::CardDecline::Verification::CardholderAddress::Result] # The address verification result returned to the card network. # @@ -1292,11 +1137,8 @@ module Result # Postal code and street address do not match. NO_MATCH = :no_match - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -1330,11 +1172,8 @@ module Category # The Declined Transaction was made for an undocumented or deprecated reason. OTHER = :other - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Increase::Models::DeclinedTransaction::Source#check_decline @@ -1385,32 +1224,17 @@ class CheckDecline < Increase::Internal::Type::BaseModel # @return [Symbol, Increase::Models::DeclinedTransaction::Source::CheckDecline::Reason] required :reason, enum: -> { Increase::Models::DeclinedTransaction::Source::CheckDecline::Reason } - # @!parse - # # A Check Decline object. This field will be present in the JSON response if and - # # only if `category` is equal to `check_decline`. - # # - # # @param amount [Integer] - # # @param auxiliary_on_us [String, nil] - # # @param back_image_file_id [String, nil] - # # @param check_transfer_id [String, nil] - # # @param front_image_file_id [String, nil] - # # @param inbound_check_deposit_id [String, nil] - # # @param reason [Symbol, Increase::Models::DeclinedTransaction::Source::CheckDecline::Reason] - # # - # def initialize( - # amount:, - # auxiliary_on_us:, - # back_image_file_id:, - # check_transfer_id:, - # front_image_file_id:, - # inbound_check_deposit_id:, - # reason:, - # ** - # ) - # super - # end - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(amount:, auxiliary_on_us:, back_image_file_id:, check_transfer_id:, front_image_file_id:, inbound_check_deposit_id:, reason:) + # A Check Decline object. This field will be present in the JSON response if and + # only if `category` is equal to `check_decline`. + # + # @param amount [Integer] + # @param auxiliary_on_us [String, nil] + # @param back_image_file_id [String, nil] + # @param check_transfer_id [String, nil] + # @param front_image_file_id [String, nil] + # @param inbound_check_deposit_id [String, nil] + # @param reason [Symbol, Increase::Models::DeclinedTransaction::Source::CheckDecline::Reason] # Why the check was declined. # @@ -1469,11 +1293,8 @@ module Reason # Your integration declined this check via the API. USER_INITIATED = :user_initiated - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -1520,20 +1341,16 @@ class CheckDepositRejection < Increase::Internal::Type::BaseModel # @return [Time] required :rejected_at, Time - # @!parse - # # A Check Deposit Rejection object. This field will be present in the JSON - # # response if and only if `category` is equal to `check_deposit_rejection`. - # # - # # @param amount [Integer] - # # @param check_deposit_id [String] - # # @param currency [Symbol, Increase::Models::DeclinedTransaction::Source::CheckDepositRejection::Currency] - # # @param declined_transaction_id [String] - # # @param reason [Symbol, Increase::Models::DeclinedTransaction::Source::CheckDepositRejection::Reason] - # # @param rejected_at [Time] - # # - # def initialize(amount:, check_deposit_id:, currency:, declined_transaction_id:, reason:, rejected_at:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(amount:, check_deposit_id:, currency:, declined_transaction_id:, reason:, rejected_at:) + # A Check Deposit Rejection object. This field will be present in the JSON + # response if and only if `category` is equal to `check_deposit_rejection`. + # + # @param amount [Integer] + # @param check_deposit_id [String] + # @param currency [Symbol, Increase::Models::DeclinedTransaction::Source::CheckDepositRejection::Currency] + # @param declined_transaction_id [String] + # @param reason [Symbol, Increase::Models::DeclinedTransaction::Source::CheckDepositRejection::Reason] + # @param rejected_at [Time] # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the check's # currency. @@ -1560,11 +1377,8 @@ module Currency # US Dollar (USD) USD = :USD - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # Why the check deposit was rejected. @@ -1606,11 +1420,8 @@ module Reason # The check was rejected for an unknown reason. UNKNOWN = :unknown - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -1681,39 +1492,21 @@ class InboundRealTimePaymentsTransferDecline < Increase::Internal::Type::BaseMod # @return [String] required :transfer_id, String - # @!parse - # # An Inbound Real-Time Payments Transfer Decline object. This field will be - # # present in the JSON response if and only if `category` is equal to - # # `inbound_real_time_payments_transfer_decline`. - # # - # # @param amount [Integer] - # # @param creditor_name [String] - # # @param currency [Symbol, Increase::Models::DeclinedTransaction::Source::InboundRealTimePaymentsTransferDecline::Currency] - # # @param debtor_account_number [String] - # # @param debtor_name [String] - # # @param debtor_routing_number [String] - # # @param reason [Symbol, Increase::Models::DeclinedTransaction::Source::InboundRealTimePaymentsTransferDecline::Reason] - # # @param remittance_information [String, nil] - # # @param transaction_identification [String] - # # @param transfer_id [String] - # # - # def initialize( - # amount:, - # creditor_name:, - # currency:, - # debtor_account_number:, - # debtor_name:, - # debtor_routing_number:, - # reason:, - # remittance_information:, - # transaction_identification:, - # transfer_id:, - # ** - # ) - # super - # end - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(amount:, creditor_name:, currency:, debtor_account_number:, debtor_name:, debtor_routing_number:, reason:, remittance_information:, transaction_identification:, transfer_id:) + # An Inbound Real-Time Payments Transfer Decline object. This field will be + # present in the JSON response if and only if `category` is equal to + # `inbound_real_time_payments_transfer_decline`. + # + # @param amount [Integer] + # @param creditor_name [String] + # @param currency [Symbol, Increase::Models::DeclinedTransaction::Source::InboundRealTimePaymentsTransferDecline::Currency] + # @param debtor_account_number [String] + # @param debtor_name [String] + # @param debtor_routing_number [String] + # @param reason [Symbol, Increase::Models::DeclinedTransaction::Source::InboundRealTimePaymentsTransferDecline::Reason] + # @param remittance_information [String, nil] + # @param transaction_identification [String] + # @param transfer_id [String] # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code of the declined # transfer's currency. This will always be "USD" for a Real-Time Payments @@ -1741,11 +1534,8 @@ module Currency # US Dollar (USD) USD = :USD - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # Why the transfer was declined. @@ -1772,11 +1562,8 @@ module Reason # Your account is not enabled to receive Real-Time Payments transfers. REAL_TIME_PAYMENTS_NOT_ENABLED = :real_time_payments_not_enabled - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -1794,16 +1581,12 @@ class WireDecline < Increase::Internal::Type::BaseModel # @return [Symbol, Increase::Models::DeclinedTransaction::Source::WireDecline::Reason] required :reason, enum: -> { Increase::Models::DeclinedTransaction::Source::WireDecline::Reason } - # @!parse - # # A Wire Decline object. This field will be present in the JSON response if and - # # only if `category` is equal to `wire_decline`. - # # - # # @param inbound_wire_transfer_id [String] - # # @param reason [Symbol, Increase::Models::DeclinedTransaction::Source::WireDecline::Reason] - # # - # def initialize(inbound_wire_transfer_id:, reason:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(inbound_wire_transfer_id:, reason:) + # A Wire Decline object. This field will be present in the JSON response if and + # only if `category` is equal to `wire_decline`. + # + # @param inbound_wire_transfer_id [String] + # @param reason [Symbol, Increase::Models::DeclinedTransaction::Source::WireDecline::Reason] # Why the wire transfer was declined. # @@ -1829,11 +1612,8 @@ module Reason # The transaction is not allowed per Increase's terms. TRANSACTION_NOT_ALLOWED = :transaction_not_allowed - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -1847,11 +1627,8 @@ module Type DECLINED_TRANSACTION = :declined_transaction - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end diff --git a/lib/increase/models/declined_transaction_list_params.rb b/lib/increase/models/declined_transaction_list_params.rb index a40c9d35a..989ca54f8 100644 --- a/lib/increase/models/declined_transaction_list_params.rb +++ b/lib/increase/models/declined_transaction_list_params.rb @@ -4,95 +4,55 @@ module Increase module Models # @see Increase::Resources::DeclinedTransactions#list class DeclinedTransactionListParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters - # @!attribute [r] account_id + # @!attribute account_id # Filter Declined Transactions to ones belonging to the specified Account. # # @return [String, nil] optional :account_id, String - # @!parse - # # @return [String] - # attr_writer :account_id - - # @!attribute [r] category + # @!attribute category # # @return [Increase::Models::DeclinedTransactionListParams::Category, nil] optional :category, -> { Increase::Models::DeclinedTransactionListParams::Category } - # @!parse - # # @return [Increase::Models::DeclinedTransactionListParams::Category] - # attr_writer :category - - # @!attribute [r] created_at + # @!attribute created_at # # @return [Increase::Models::DeclinedTransactionListParams::CreatedAt, nil] optional :created_at, -> { Increase::Models::DeclinedTransactionListParams::CreatedAt } - # @!parse - # # @return [Increase::Models::DeclinedTransactionListParams::CreatedAt] - # attr_writer :created_at - - # @!attribute [r] cursor + # @!attribute cursor # Return the page of entries after this one. # # @return [String, nil] optional :cursor, String - # @!parse - # # @return [String] - # attr_writer :cursor - - # @!attribute [r] limit + # @!attribute limit # Limit the size of the list that is returned. The default (and maximum) is 100 # objects. # # @return [Integer, nil] optional :limit, Integer - # @!parse - # # @return [Integer] - # attr_writer :limit - - # @!attribute [r] route_id + # @!attribute route_id # Filter Declined Transactions to those belonging to the specified route. # # @return [String, nil] optional :route_id, String - # @!parse - # # @return [String] - # attr_writer :route_id - - # @!parse - # # @param account_id [String] - # # @param category [Increase::Models::DeclinedTransactionListParams::Category] - # # @param created_at [Increase::Models::DeclinedTransactionListParams::CreatedAt] - # # @param cursor [String] - # # @param limit [Integer] - # # @param route_id [String] - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize( - # account_id: nil, - # category: nil, - # created_at: nil, - # cursor: nil, - # limit: nil, - # route_id: nil, - # request_options: {}, - # ** - # ) - # super - # end - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(account_id: nil, category: nil, created_at: nil, cursor: nil, limit: nil, route_id: nil, request_options: {}) + # @param account_id [String] + # @param category [Increase::Models::DeclinedTransactionListParams::Category] + # @param created_at [Increase::Models::DeclinedTransactionListParams::CreatedAt] + # @param cursor [String] + # @param limit [Integer] + # @param route_id [String] + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] class Category < Increase::Internal::Type::BaseModel - # @!attribute [r] in_ + # @!attribute in_ # Return results whose value is in the provided list. For GET requests, this # should be encoded as a comma-delimited string, such as `?in=one,two,three`. # @@ -101,16 +61,8 @@ class Category < Increase::Internal::Type::BaseModel -> { Increase::Internal::Type::ArrayOf[enum: Increase::Models::DeclinedTransactionListParams::Category::In] }, api_name: :in - # @!parse - # # @return [Array] - # attr_writer :in_ - - # @!parse - # # @param in_ [Array] - # # - # def initialize(in_: nil, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(in_: nil) + # @param in_ [Array] module In extend Increase::Internal::Type::Enum @@ -136,68 +88,45 @@ module In # The Declined Transaction was made for an undocumented or deprecated reason. OTHER = :other - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end class CreatedAt < Increase::Internal::Type::BaseModel - # @!attribute [r] after + # @!attribute after # Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) # timestamp. # # @return [Time, nil] optional :after, Time - # @!parse - # # @return [Time] - # attr_writer :after - - # @!attribute [r] before + # @!attribute before # Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) # timestamp. # # @return [Time, nil] optional :before, Time - # @!parse - # # @return [Time] - # attr_writer :before - - # @!attribute [r] on_or_after + # @!attribute on_or_after # Return results on or after this # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. # # @return [Time, nil] optional :on_or_after, Time - # @!parse - # # @return [Time] - # attr_writer :on_or_after - - # @!attribute [r] on_or_before + # @!attribute on_or_before # Return results on or before this # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. # # @return [Time, nil] optional :on_or_before, Time - # @!parse - # # @return [Time] - # attr_writer :on_or_before - - # @!parse - # # @param after [Time] - # # @param before [Time] - # # @param on_or_after [Time] - # # @param on_or_before [Time] - # # - # def initialize(after: nil, before: nil, on_or_after: nil, on_or_before: nil, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(after: nil, before: nil, on_or_after: nil, on_or_before: nil) + # @param after [Time] + # @param before [Time] + # @param on_or_after [Time] + # @param on_or_before [Time] end end end diff --git a/lib/increase/models/declined_transaction_retrieve_params.rb b/lib/increase/models/declined_transaction_retrieve_params.rb index 0fdbf7d1a..a1f785dad 100644 --- a/lib/increase/models/declined_transaction_retrieve_params.rb +++ b/lib/increase/models/declined_transaction_retrieve_params.rb @@ -4,16 +4,11 @@ module Increase module Models # @see Increase::Resources::DeclinedTransactions#retrieve class DeclinedTransactionRetrieveParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters - # @!parse - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(request_options: {}, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(request_options: {}) + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/increase/models/digital_card_profile.rb b/lib/increase/models/digital_card_profile.rb index 036a2f2d3..223ebca5b 100644 --- a/lib/increase/models/digital_card_profile.rb +++ b/lib/increase/models/digital_card_profile.rb @@ -92,47 +92,25 @@ class DigitalCardProfile < Increase::Internal::Type::BaseModel # @return [Symbol, Increase::Models::DigitalCardProfile::Type] required :type, enum: -> { Increase::Models::DigitalCardProfile::Type } - # @!parse - # # This contains artwork and metadata relating to a Card's appearance in digital - # # wallet apps like Apple Pay and Google Pay. For more information, see our guide - # # on [digital card artwork](https://increase.com/documentation/card-art). - # # - # # @param id [String] - # # @param app_icon_file_id [String] - # # @param background_image_file_id [String] - # # @param card_description [String] - # # @param contact_email [String, nil] - # # @param contact_phone [String, nil] - # # @param contact_website [String, nil] - # # @param created_at [Time] - # # @param description [String] - # # @param idempotency_key [String, nil] - # # @param issuer_name [String] - # # @param status [Symbol, Increase::Models::DigitalCardProfile::Status] - # # @param text_color [Increase::Models::DigitalCardProfile::TextColor] - # # @param type [Symbol, Increase::Models::DigitalCardProfile::Type] - # # - # def initialize( - # id:, - # app_icon_file_id:, - # background_image_file_id:, - # card_description:, - # contact_email:, - # contact_phone:, - # contact_website:, - # created_at:, - # description:, - # idempotency_key:, - # issuer_name:, - # status:, - # text_color:, - # type:, - # ** - # ) - # super - # end - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(id:, app_icon_file_id:, background_image_file_id:, card_description:, contact_email:, contact_phone:, contact_website:, created_at:, description:, idempotency_key:, issuer_name:, status:, text_color:, type:) + # This contains artwork and metadata relating to a Card's appearance in digital + # wallet apps like Apple Pay and Google Pay. For more information, see our guide + # on [digital card artwork](https://increase.com/documentation/card-art). + # + # @param id [String] + # @param app_icon_file_id [String] + # @param background_image_file_id [String] + # @param card_description [String] + # @param contact_email [String, nil] + # @param contact_phone [String, nil] + # @param contact_website [String, nil] + # @param created_at [Time] + # @param description [String] + # @param idempotency_key [String, nil] + # @param issuer_name [String] + # @param status [Symbol, Increase::Models::DigitalCardProfile::Status] + # @param text_color [Increase::Models::DigitalCardProfile::TextColor] + # @param type [Symbol, Increase::Models::DigitalCardProfile::Type] # The status of the Card Profile. # @@ -152,11 +130,8 @@ module Status # The Card Profile is no longer in use. ARCHIVED = :archived - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Increase::Models::DigitalCardProfile#text_color @@ -179,16 +154,12 @@ class TextColor < Increase::Internal::Type::BaseModel # @return [Integer] required :red, Integer - # @!parse - # # The Card's text color, specified as an RGB triple. - # # - # # @param blue [Integer] - # # @param green [Integer] - # # @param red [Integer] - # # - # def initialize(blue:, green:, red:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(blue:, green:, red:) + # The Card's text color, specified as an RGB triple. + # + # @param blue [Integer] + # @param green [Integer] + # @param red [Integer] end # A constant representing the object's type. For this resource it will always be @@ -200,11 +171,8 @@ module Type DIGITAL_CARD_PROFILE = :digital_card_profile - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end diff --git a/lib/increase/models/digital_card_profile_archive_params.rb b/lib/increase/models/digital_card_profile_archive_params.rb index 738c4e52e..1bd23de5d 100644 --- a/lib/increase/models/digital_card_profile_archive_params.rb +++ b/lib/increase/models/digital_card_profile_archive_params.rb @@ -4,16 +4,11 @@ module Increase module Models # @see Increase::Resources::DigitalCardProfiles#archive class DigitalCardProfileArchiveParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters - # @!parse - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(request_options: {}, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(request_options: {}) + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/increase/models/digital_card_profile_clone_params.rb b/lib/increase/models/digital_card_profile_clone_params.rb index 92f598575..364c1924a 100644 --- a/lib/increase/models/digital_card_profile_clone_params.rb +++ b/lib/increase/models/digital_card_profile_clone_params.rb @@ -4,129 +4,74 @@ module Increase module Models # @see Increase::Resources::DigitalCardProfiles#clone_ class DigitalCardProfileCloneParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters - # @!attribute [r] app_icon_file_id + # @!attribute app_icon_file_id # The identifier of the File containing the card's icon image. # # @return [String, nil] optional :app_icon_file_id, String - # @!parse - # # @return [String] - # attr_writer :app_icon_file_id - - # @!attribute [r] background_image_file_id + # @!attribute background_image_file_id # The identifier of the File containing the card's front image. # # @return [String, nil] optional :background_image_file_id, String - # @!parse - # # @return [String] - # attr_writer :background_image_file_id - - # @!attribute [r] card_description + # @!attribute card_description # A user-facing description for the card itself. # # @return [String, nil] optional :card_description, String - # @!parse - # # @return [String] - # attr_writer :card_description - - # @!attribute [r] contact_email + # @!attribute contact_email # An email address the user can contact to receive support for their card. # # @return [String, nil] optional :contact_email, String - # @!parse - # # @return [String] - # attr_writer :contact_email - - # @!attribute [r] contact_phone + # @!attribute contact_phone # A phone number the user can contact to receive support for their card. # # @return [String, nil] optional :contact_phone, String - # @!parse - # # @return [String] - # attr_writer :contact_phone - - # @!attribute [r] contact_website + # @!attribute contact_website # A website the user can visit to view and receive support for their card. # # @return [String, nil] optional :contact_website, String - # @!parse - # # @return [String] - # attr_writer :contact_website - - # @!attribute [r] description + # @!attribute description # A description you can use to identify the Card Profile. # # @return [String, nil] optional :description, String - # @!parse - # # @return [String] - # attr_writer :description - - # @!attribute [r] issuer_name + # @!attribute issuer_name # A user-facing description for whoever is issuing the card. # # @return [String, nil] optional :issuer_name, String - # @!parse - # # @return [String] - # attr_writer :issuer_name - - # @!attribute [r] text_color + # @!attribute text_color # The Card's text color, specified as an RGB triple. The default is white. # # @return [Increase::Models::DigitalCardProfileCloneParams::TextColor, nil] optional :text_color, -> { Increase::Models::DigitalCardProfileCloneParams::TextColor } - # @!parse - # # @return [Increase::Models::DigitalCardProfileCloneParams::TextColor] - # attr_writer :text_color - - # @!parse - # # @param app_icon_file_id [String] - # # @param background_image_file_id [String] - # # @param card_description [String] - # # @param contact_email [String] - # # @param contact_phone [String] - # # @param contact_website [String] - # # @param description [String] - # # @param issuer_name [String] - # # @param text_color [Increase::Models::DigitalCardProfileCloneParams::TextColor] - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize( - # app_icon_file_id: nil, - # background_image_file_id: nil, - # card_description: nil, - # contact_email: nil, - # contact_phone: nil, - # contact_website: nil, - # description: nil, - # issuer_name: nil, - # text_color: nil, - # request_options: {}, - # ** - # ) - # super - # end - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(app_icon_file_id: nil, background_image_file_id: nil, card_description: nil, contact_email: nil, contact_phone: nil, contact_website: nil, description: nil, issuer_name: nil, text_color: nil, request_options: {}) + # @param app_icon_file_id [String] + # @param background_image_file_id [String] + # @param card_description [String] + # @param contact_email [String] + # @param contact_phone [String] + # @param contact_website [String] + # @param description [String] + # @param issuer_name [String] + # @param text_color [Increase::Models::DigitalCardProfileCloneParams::TextColor] + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] class TextColor < Increase::Internal::Type::BaseModel # @!attribute blue @@ -147,16 +92,12 @@ class TextColor < Increase::Internal::Type::BaseModel # @return [Integer] required :red, Integer - # @!parse - # # The Card's text color, specified as an RGB triple. The default is white. - # # - # # @param blue [Integer] - # # @param green [Integer] - # # @param red [Integer] - # # - # def initialize(blue:, green:, red:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(blue:, green:, red:) + # The Card's text color, specified as an RGB triple. The default is white. + # + # @param blue [Integer] + # @param green [Integer] + # @param red [Integer] end end end diff --git a/lib/increase/models/digital_card_profile_create_params.rb b/lib/increase/models/digital_card_profile_create_params.rb index ec37141f1..0d09ede28 100644 --- a/lib/increase/models/digital_card_profile_create_params.rb +++ b/lib/increase/models/digital_card_profile_create_params.rb @@ -4,8 +4,7 @@ module Increase module Models # @see Increase::Resources::DigitalCardProfiles#create class DigitalCardProfileCreateParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters # @!attribute app_icon_file_id @@ -38,75 +37,41 @@ class DigitalCardProfileCreateParams < Increase::Internal::Type::BaseModel # @return [String] required :issuer_name, String - # @!attribute [r] contact_email + # @!attribute contact_email # An email address the user can contact to receive support for their card. # # @return [String, nil] optional :contact_email, String - # @!parse - # # @return [String] - # attr_writer :contact_email - - # @!attribute [r] contact_phone + # @!attribute contact_phone # A phone number the user can contact to receive support for their card. # # @return [String, nil] optional :contact_phone, String - # @!parse - # # @return [String] - # attr_writer :contact_phone - - # @!attribute [r] contact_website + # @!attribute contact_website # A website the user can visit to view and receive support for their card. # # @return [String, nil] optional :contact_website, String - # @!parse - # # @return [String] - # attr_writer :contact_website - - # @!attribute [r] text_color + # @!attribute text_color # The Card's text color, specified as an RGB triple. The default is white. # # @return [Increase::Models::DigitalCardProfileCreateParams::TextColor, nil] optional :text_color, -> { Increase::Models::DigitalCardProfileCreateParams::TextColor } - # @!parse - # # @return [Increase::Models::DigitalCardProfileCreateParams::TextColor] - # attr_writer :text_color - - # @!parse - # # @param app_icon_file_id [String] - # # @param background_image_file_id [String] - # # @param card_description [String] - # # @param description [String] - # # @param issuer_name [String] - # # @param contact_email [String] - # # @param contact_phone [String] - # # @param contact_website [String] - # # @param text_color [Increase::Models::DigitalCardProfileCreateParams::TextColor] - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize( - # app_icon_file_id:, - # background_image_file_id:, - # card_description:, - # description:, - # issuer_name:, - # contact_email: nil, - # contact_phone: nil, - # contact_website: nil, - # text_color: nil, - # request_options: {}, - # ** - # ) - # super - # end - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(app_icon_file_id:, background_image_file_id:, card_description:, description:, issuer_name:, contact_email: nil, contact_phone: nil, contact_website: nil, text_color: nil, request_options: {}) + # @param app_icon_file_id [String] + # @param background_image_file_id [String] + # @param card_description [String] + # @param description [String] + # @param issuer_name [String] + # @param contact_email [String] + # @param contact_phone [String] + # @param contact_website [String] + # @param text_color [Increase::Models::DigitalCardProfileCreateParams::TextColor] + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] class TextColor < Increase::Internal::Type::BaseModel # @!attribute blue @@ -127,16 +92,12 @@ class TextColor < Increase::Internal::Type::BaseModel # @return [Integer] required :red, Integer - # @!parse - # # The Card's text color, specified as an RGB triple. The default is white. - # # - # # @param blue [Integer] - # # @param green [Integer] - # # @param red [Integer] - # # - # def initialize(blue:, green:, red:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(blue:, green:, red:) + # The Card's text color, specified as an RGB triple. The default is white. + # + # @param blue [Integer] + # @param green [Integer] + # @param red [Integer] end end end diff --git a/lib/increase/models/digital_card_profile_list_params.rb b/lib/increase/models/digital_card_profile_list_params.rb index f7deb6992..c20e660b0 100644 --- a/lib/increase/models/digital_card_profile_list_params.rb +++ b/lib/increase/models/digital_card_profile_list_params.rb @@ -4,21 +4,16 @@ module Increase module Models # @see Increase::Resources::DigitalCardProfiles#list class DigitalCardProfileListParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters - # @!attribute [r] cursor + # @!attribute cursor # Return the page of entries after this one. # # @return [String, nil] optional :cursor, String - # @!parse - # # @return [String] - # attr_writer :cursor - - # @!attribute [r] idempotency_key + # @!attribute idempotency_key # Filter records to the one with the specified `idempotency_key` you chose for # that object. This value is unique across Increase and is used to ensure that a # request is only processed once. Learn more about @@ -27,43 +22,27 @@ class DigitalCardProfileListParams < Increase::Internal::Type::BaseModel # @return [String, nil] optional :idempotency_key, String - # @!parse - # # @return [String] - # attr_writer :idempotency_key - - # @!attribute [r] limit + # @!attribute limit # Limit the size of the list that is returned. The default (and maximum) is 100 # objects. # # @return [Integer, nil] optional :limit, Integer - # @!parse - # # @return [Integer] - # attr_writer :limit - - # @!attribute [r] status + # @!attribute status # # @return [Increase::Models::DigitalCardProfileListParams::Status, nil] optional :status, -> { Increase::Models::DigitalCardProfileListParams::Status } - # @!parse - # # @return [Increase::Models::DigitalCardProfileListParams::Status] - # attr_writer :status - - # @!parse - # # @param cursor [String] - # # @param idempotency_key [String] - # # @param limit [Integer] - # # @param status [Increase::Models::DigitalCardProfileListParams::Status] - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(cursor: nil, idempotency_key: nil, limit: nil, status: nil, request_options: {}, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(cursor: nil, idempotency_key: nil, limit: nil, status: nil, request_options: {}) + # @param cursor [String] + # @param idempotency_key [String] + # @param limit [Integer] + # @param status [Increase::Models::DigitalCardProfileListParams::Status] + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] class Status < Increase::Internal::Type::BaseModel - # @!attribute [r] in_ + # @!attribute in_ # Filter Digital Card Profiles for those with the specified digital wallet status # or statuses. For GET requests, this should be encoded as a comma-delimited # string, such as `?in=one,two,three`. @@ -73,16 +52,8 @@ class Status < Increase::Internal::Type::BaseModel -> { Increase::Internal::Type::ArrayOf[enum: Increase::Models::DigitalCardProfileListParams::Status::In] }, api_name: :in - # @!parse - # # @return [Array] - # attr_writer :in_ - - # @!parse - # # @param in_ [Array] - # # - # def initialize(in_: nil, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(in_: nil) + # @param in_ [Array] module In extend Increase::Internal::Type::Enum @@ -99,11 +70,8 @@ module In # The Card Profile is no longer in use. ARCHIVED = :archived - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end diff --git a/lib/increase/models/digital_card_profile_retrieve_params.rb b/lib/increase/models/digital_card_profile_retrieve_params.rb index 943bfa484..880d5b3a7 100644 --- a/lib/increase/models/digital_card_profile_retrieve_params.rb +++ b/lib/increase/models/digital_card_profile_retrieve_params.rb @@ -4,16 +4,11 @@ module Increase module Models # @see Increase::Resources::DigitalCardProfiles#retrieve class DigitalCardProfileRetrieveParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters - # @!parse - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(request_options: {}, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(request_options: {}) + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/increase/models/digital_wallet_token.rb b/lib/increase/models/digital_wallet_token.rb index 36eb3d558..3d5aaea6f 100644 --- a/lib/increase/models/digital_wallet_token.rb +++ b/lib/increase/models/digital_wallet_token.rb @@ -60,24 +60,20 @@ class DigitalWalletToken < Increase::Internal::Type::BaseModel # @return [Array] required :updates, -> { Increase::Internal::Type::ArrayOf[Increase::Models::DigitalWalletToken::Update] } - # @!parse - # # A Digital Wallet Token is created when a user adds a Card to their Apple Pay or - # # Google Pay app. The Digital Wallet Token can be used for purchases just like a - # # Card. - # # - # # @param id [String] - # # @param card_id [String] - # # @param cardholder [Increase::Models::DigitalWalletToken::Cardholder] - # # @param created_at [Time] - # # @param device [Increase::Models::DigitalWalletToken::Device] - # # @param status [Symbol, Increase::Models::DigitalWalletToken::Status] - # # @param token_requestor [Symbol, Increase::Models::DigitalWalletToken::TokenRequestor] - # # @param type [Symbol, Increase::Models::DigitalWalletToken::Type] - # # @param updates [Array] - # # - # def initialize(id:, card_id:, cardholder:, created_at:, device:, status:, token_requestor:, type:, updates:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(id:, card_id:, cardholder:, created_at:, device:, status:, token_requestor:, type:, updates:) + # A Digital Wallet Token is created when a user adds a Card to their Apple Pay or + # Google Pay app. The Digital Wallet Token can be used for purchases just like a + # Card. + # + # @param id [String] + # @param card_id [String] + # @param cardholder [Increase::Models::DigitalWalletToken::Cardholder] + # @param created_at [Time] + # @param device [Increase::Models::DigitalWalletToken::Device] + # @param status [Symbol, Increase::Models::DigitalWalletToken::Status] + # @param token_requestor [Symbol, Increase::Models::DigitalWalletToken::TokenRequestor] + # @param type [Symbol, Increase::Models::DigitalWalletToken::Type] + # @param updates [Array] # @see Increase::Models::DigitalWalletToken#cardholder class Cardholder < Increase::Internal::Type::BaseModel @@ -87,14 +83,10 @@ class Cardholder < Increase::Internal::Type::BaseModel # @return [String, nil] required :name, String, nil?: true - # @!parse - # # The cardholder information given when the Digital Wallet Token was created. - # # - # # @param name [String, nil] - # # - # def initialize(name:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(name:) + # The cardholder information given when the Digital Wallet Token was created. + # + # @param name [String, nil] end # @see Increase::Models::DigitalWalletToken#device @@ -123,17 +115,13 @@ class Device < Increase::Internal::Type::BaseModel # @return [String, nil] required :name, String, nil?: true - # @!parse - # # The device that was used to create the Digital Wallet Token. - # # - # # @param device_type [Symbol, Increase::Models::DigitalWalletToken::Device::DeviceType, nil] - # # @param identifier [String, nil] - # # @param ip_address [String, nil] - # # @param name [String, nil] - # # - # def initialize(device_type:, identifier:, ip_address:, name:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(device_type:, identifier:, ip_address:, name:) + # The device that was used to create the Digital Wallet Token. + # + # @param device_type [Symbol, Increase::Models::DigitalWalletToken::Device::DeviceType, nil] + # @param identifier [String, nil] + # @param ip_address [String, nil] + # @param name [String, nil] # Device type. # @@ -168,11 +156,8 @@ module DeviceType # Automobile Device AUTOMOBILE_DEVICE = :automobile_device - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -194,11 +179,8 @@ module Status # The digital wallet token has been permanently canceled. DEACTIVATED = :deactivated - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # The digital wallet app being used. @@ -219,11 +201,8 @@ module TokenRequestor # Unknown UNKNOWN = :unknown - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # A constant representing the object's type. For this resource it will always be @@ -235,11 +214,8 @@ module Type DIGITAL_WALLET_TOKEN = :digital_wallet_token - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end class Update < Increase::Internal::Type::BaseModel @@ -256,13 +232,9 @@ class Update < Increase::Internal::Type::BaseModel # @return [Time] required :timestamp, Time - # @!parse - # # @param status [Symbol, Increase::Models::DigitalWalletToken::Update::Status] - # # @param timestamp [Time] - # # - # def initialize(status:, timestamp:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(status:, timestamp:) + # @param status [Symbol, Increase::Models::DigitalWalletToken::Update::Status] + # @param timestamp [Time] # The status the update changed this Digital Wallet Token to. # @@ -282,11 +254,8 @@ module Status # The digital wallet token has been permanently canceled. DEACTIVATED = :deactivated - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end diff --git a/lib/increase/models/digital_wallet_token_list_params.rb b/lib/increase/models/digital_wallet_token_list_params.rb index 13fe99134..3b54867d7 100644 --- a/lib/increase/models/digital_wallet_token_list_params.rb +++ b/lib/increase/models/digital_wallet_token_list_params.rb @@ -4,115 +4,74 @@ module Increase module Models # @see Increase::Resources::DigitalWalletTokens#list class DigitalWalletTokenListParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters - # @!attribute [r] card_id + # @!attribute card_id # Filter Digital Wallet Tokens to ones belonging to the specified Card. # # @return [String, nil] optional :card_id, String - # @!parse - # # @return [String] - # attr_writer :card_id - - # @!attribute [r] created_at + # @!attribute created_at # # @return [Increase::Models::DigitalWalletTokenListParams::CreatedAt, nil] optional :created_at, -> { Increase::Models::DigitalWalletTokenListParams::CreatedAt } - # @!parse - # # @return [Increase::Models::DigitalWalletTokenListParams::CreatedAt] - # attr_writer :created_at - - # @!attribute [r] cursor + # @!attribute cursor # Return the page of entries after this one. # # @return [String, nil] optional :cursor, String - # @!parse - # # @return [String] - # attr_writer :cursor - - # @!attribute [r] limit + # @!attribute limit # Limit the size of the list that is returned. The default (and maximum) is 100 # objects. # # @return [Integer, nil] optional :limit, Integer - # @!parse - # # @return [Integer] - # attr_writer :limit - - # @!parse - # # @param card_id [String] - # # @param created_at [Increase::Models::DigitalWalletTokenListParams::CreatedAt] - # # @param cursor [String] - # # @param limit [Integer] - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(card_id: nil, created_at: nil, cursor: nil, limit: nil, request_options: {}, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(card_id: nil, created_at: nil, cursor: nil, limit: nil, request_options: {}) + # @param card_id [String] + # @param created_at [Increase::Models::DigitalWalletTokenListParams::CreatedAt] + # @param cursor [String] + # @param limit [Integer] + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] class CreatedAt < Increase::Internal::Type::BaseModel - # @!attribute [r] after + # @!attribute after # Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) # timestamp. # # @return [Time, nil] optional :after, Time - # @!parse - # # @return [Time] - # attr_writer :after - - # @!attribute [r] before + # @!attribute before # Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) # timestamp. # # @return [Time, nil] optional :before, Time - # @!parse - # # @return [Time] - # attr_writer :before - - # @!attribute [r] on_or_after + # @!attribute on_or_after # Return results on or after this # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. # # @return [Time, nil] optional :on_or_after, Time - # @!parse - # # @return [Time] - # attr_writer :on_or_after - - # @!attribute [r] on_or_before + # @!attribute on_or_before # Return results on or before this # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. # # @return [Time, nil] optional :on_or_before, Time - # @!parse - # # @return [Time] - # attr_writer :on_or_before - - # @!parse - # # @param after [Time] - # # @param before [Time] - # # @param on_or_after [Time] - # # @param on_or_before [Time] - # # - # def initialize(after: nil, before: nil, on_or_after: nil, on_or_before: nil, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(after: nil, before: nil, on_or_after: nil, on_or_before: nil) + # @param after [Time] + # @param before [Time] + # @param on_or_after [Time] + # @param on_or_before [Time] end end end diff --git a/lib/increase/models/digital_wallet_token_retrieve_params.rb b/lib/increase/models/digital_wallet_token_retrieve_params.rb index 223541223..0b68c09aa 100644 --- a/lib/increase/models/digital_wallet_token_retrieve_params.rb +++ b/lib/increase/models/digital_wallet_token_retrieve_params.rb @@ -4,16 +4,11 @@ module Increase module Models # @see Increase::Resources::DigitalWalletTokens#retrieve class DigitalWalletTokenRetrieveParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters - # @!parse - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(request_options: {}, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(request_options: {}) + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/increase/models/document.rb b/lib/increase/models/document.rb index 925aa7a9a..f9144be04 100644 --- a/lib/increase/models/document.rb +++ b/lib/increase/models/document.rb @@ -42,20 +42,16 @@ class Document < Increase::Internal::Type::BaseModel # @return [Symbol, Increase::Models::Document::Type] required :type, enum: -> { Increase::Models::Document::Type } - # @!parse - # # Increase generates certain documents / forms automatically for your application; - # # they can be listed here. - # # - # # @param id [String] - # # @param category [Symbol, Increase::Models::Document::Category] - # # @param created_at [Time] - # # @param entity_id [String, nil] - # # @param file_id [String] - # # @param type [Symbol, Increase::Models::Document::Type] - # # - # def initialize(id:, category:, created_at:, entity_id:, file_id:, type:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(id:, category:, created_at:, entity_id:, file_id:, type:) + # Increase generates certain documents / forms automatically for your application; + # they can be listed here. + # + # @param id [String] + # @param category [Symbol, Increase::Models::Document::Category] + # @param created_at [Time] + # @param entity_id [String, nil] + # @param file_id [String] + # @param type [Symbol, Increase::Models::Document::Type] # The type of document. # @@ -75,11 +71,8 @@ module Category # Company information, such a policies or procedures, typically submitted during our due diligence process. COMPANY_INFORMATION = :company_information - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # A constant representing the object's type. For this resource it will always be @@ -91,11 +84,8 @@ module Type DOCUMENT = :document - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end diff --git a/lib/increase/models/document_list_params.rb b/lib/increase/models/document_list_params.rb index b98929af1..380da924b 100644 --- a/lib/increase/models/document_list_params.rb +++ b/lib/increase/models/document_list_params.rb @@ -4,73 +4,48 @@ module Increase module Models # @see Increase::Resources::Documents#list class DocumentListParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters - # @!attribute [r] category + # @!attribute category # # @return [Increase::Models::DocumentListParams::Category, nil] optional :category, -> { Increase::Models::DocumentListParams::Category } - # @!parse - # # @return [Increase::Models::DocumentListParams::Category] - # attr_writer :category - - # @!attribute [r] created_at + # @!attribute created_at # # @return [Increase::Models::DocumentListParams::CreatedAt, nil] optional :created_at, -> { Increase::Models::DocumentListParams::CreatedAt } - # @!parse - # # @return [Increase::Models::DocumentListParams::CreatedAt] - # attr_writer :created_at - - # @!attribute [r] cursor + # @!attribute cursor # Return the page of entries after this one. # # @return [String, nil] optional :cursor, String - # @!parse - # # @return [String] - # attr_writer :cursor - - # @!attribute [r] entity_id + # @!attribute entity_id # Filter Documents to ones belonging to the specified Entity. # # @return [String, nil] optional :entity_id, String - # @!parse - # # @return [String] - # attr_writer :entity_id - - # @!attribute [r] limit + # @!attribute limit # Limit the size of the list that is returned. The default (and maximum) is 100 # objects. # # @return [Integer, nil] optional :limit, Integer - # @!parse - # # @return [Integer] - # attr_writer :limit - - # @!parse - # # @param category [Increase::Models::DocumentListParams::Category] - # # @param created_at [Increase::Models::DocumentListParams::CreatedAt] - # # @param cursor [String] - # # @param entity_id [String] - # # @param limit [Integer] - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(category: nil, created_at: nil, cursor: nil, entity_id: nil, limit: nil, request_options: {}, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(category: nil, created_at: nil, cursor: nil, entity_id: nil, limit: nil, request_options: {}) + # @param category [Increase::Models::DocumentListParams::Category] + # @param created_at [Increase::Models::DocumentListParams::CreatedAt] + # @param cursor [String] + # @param entity_id [String] + # @param limit [Integer] + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] class Category < Increase::Internal::Type::BaseModel - # @!attribute [r] in_ + # @!attribute in_ # Filter Documents for those with the specified category or categories. For GET # requests, this should be encoded as a comma-delimited string, such as # `?in=one,two,three`. @@ -80,16 +55,8 @@ class Category < Increase::Internal::Type::BaseModel -> { Increase::Internal::Type::ArrayOf[enum: Increase::Models::DocumentListParams::Category::In] }, api_name: :in - # @!parse - # # @return [Array] - # attr_writer :in_ - - # @!parse - # # @param in_ [Array] - # # - # def initialize(in_: nil, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(in_: nil) + # @param in_ [Array] module In extend Increase::Internal::Type::Enum @@ -106,68 +73,45 @@ module In # Company information, such a policies or procedures, typically submitted during our due diligence process. COMPANY_INFORMATION = :company_information - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end class CreatedAt < Increase::Internal::Type::BaseModel - # @!attribute [r] after + # @!attribute after # Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) # timestamp. # # @return [Time, nil] optional :after, Time - # @!parse - # # @return [Time] - # attr_writer :after - - # @!attribute [r] before + # @!attribute before # Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) # timestamp. # # @return [Time, nil] optional :before, Time - # @!parse - # # @return [Time] - # attr_writer :before - - # @!attribute [r] on_or_after + # @!attribute on_or_after # Return results on or after this # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. # # @return [Time, nil] optional :on_or_after, Time - # @!parse - # # @return [Time] - # attr_writer :on_or_after - - # @!attribute [r] on_or_before + # @!attribute on_or_before # Return results on or before this # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. # # @return [Time, nil] optional :on_or_before, Time - # @!parse - # # @return [Time] - # attr_writer :on_or_before - - # @!parse - # # @param after [Time] - # # @param before [Time] - # # @param on_or_after [Time] - # # @param on_or_before [Time] - # # - # def initialize(after: nil, before: nil, on_or_after: nil, on_or_before: nil, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(after: nil, before: nil, on_or_after: nil, on_or_before: nil) + # @param after [Time] + # @param before [Time] + # @param on_or_after [Time] + # @param on_or_before [Time] end end end diff --git a/lib/increase/models/document_retrieve_params.rb b/lib/increase/models/document_retrieve_params.rb index 9faf91ff4..2c21dc0ec 100644 --- a/lib/increase/models/document_retrieve_params.rb +++ b/lib/increase/models/document_retrieve_params.rb @@ -4,16 +4,11 @@ module Increase module Models # @see Increase::Resources::Documents#retrieve class DocumentRetrieveParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters - # @!parse - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(request_options: {}, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(request_options: {}) + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/increase/models/entity.rb b/lib/increase/models/entity.rb index 62b520142..19a4e5e59 100644 --- a/lib/increase/models/entity.rb +++ b/lib/increase/models/entity.rb @@ -106,48 +106,25 @@ class Entity < Increase::Internal::Type::BaseModel # @return [Symbol, Increase::Models::Entity::Type] required :type, enum: -> { Increase::Models::Entity::Type } - # @!parse - # # Entities are the legal entities that own accounts. They can be people, - # # corporations, partnerships, government authorities, or trusts. - # # - # # @param id [String] - # # @param corporation [Increase::Models::Entity::Corporation, nil] - # # @param created_at [Time] - # # @param description [String, nil] - # # @param details_confirmed_at [Time, nil] - # # @param government_authority [Increase::Models::Entity::GovernmentAuthority, nil] - # # @param idempotency_key [String, nil] - # # @param joint [Increase::Models::Entity::Joint, nil] - # # @param natural_person [Increase::Models::Entity::NaturalPerson, nil] - # # @param status [Symbol, Increase::Models::Entity::Status] - # # @param structure [Symbol, Increase::Models::Entity::Structure] - # # @param supplemental_documents [Array] - # # @param third_party_verification [Increase::Models::Entity::ThirdPartyVerification, nil] - # # @param trust [Increase::Models::Entity::Trust, nil] - # # @param type [Symbol, Increase::Models::Entity::Type] - # # - # def initialize( - # id:, - # corporation:, - # created_at:, - # description:, - # details_confirmed_at:, - # government_authority:, - # idempotency_key:, - # joint:, - # natural_person:, - # status:, - # structure:, - # supplemental_documents:, - # third_party_verification:, - # trust:, - # type:, - # ** - # ) - # super - # end - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(id:, corporation:, created_at:, description:, details_confirmed_at:, government_authority:, idempotency_key:, joint:, natural_person:, status:, structure:, supplemental_documents:, third_party_verification:, trust:, type:) + # Entities are the legal entities that own accounts. They can be people, + # corporations, partnerships, government authorities, or trusts. + # + # @param id [String] + # @param corporation [Increase::Models::Entity::Corporation, nil] + # @param created_at [Time] + # @param description [String, nil] + # @param details_confirmed_at [Time, nil] + # @param government_authority [Increase::Models::Entity::GovernmentAuthority, nil] + # @param idempotency_key [String, nil] + # @param joint [Increase::Models::Entity::Joint, nil] + # @param natural_person [Increase::Models::Entity::NaturalPerson, nil] + # @param status [Symbol, Increase::Models::Entity::Status] + # @param structure [Symbol, Increase::Models::Entity::Structure] + # @param supplemental_documents [Array] + # @param third_party_verification [Increase::Models::Entity::ThirdPartyVerification, nil] + # @param trust [Increase::Models::Entity::Trust, nil] + # @param type [Symbol, Increase::Models::Entity::Type] # @see Increase::Models::Entity#corporation class Corporation < Increase::Internal::Type::BaseModel @@ -197,21 +174,17 @@ class Corporation < Increase::Internal::Type::BaseModel # @return [String, nil] required :website, String, nil?: true - # @!parse - # # Details of the corporation entity. Will be present if `structure` is equal to - # # `corporation`. - # # - # # @param address [Increase::Models::Entity::Corporation::Address] - # # @param beneficial_owners [Array] - # # @param incorporation_state [String, nil] - # # @param industry_code [String, nil] - # # @param name [String] - # # @param tax_identifier [String, nil] - # # @param website [String, nil] - # # - # def initialize(address:, beneficial_owners:, incorporation_state:, industry_code:, name:, tax_identifier:, website:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(address:, beneficial_owners:, incorporation_state:, industry_code:, name:, tax_identifier:, website:) + # Details of the corporation entity. Will be present if `structure` is equal to + # `corporation`. + # + # @param address [Increase::Models::Entity::Corporation::Address] + # @param beneficial_owners [Array] + # @param incorporation_state [String, nil] + # @param industry_code [String, nil] + # @param name [String] + # @param tax_identifier [String, nil] + # @param website [String, nil] # @see Increase::Models::Entity::Corporation#address class Address < Increase::Internal::Type::BaseModel @@ -246,18 +219,14 @@ class Address < Increase::Internal::Type::BaseModel # @return [String] required :zip, String - # @!parse - # # The corporation's address. - # # - # # @param city [String] - # # @param line1 [String] - # # @param line2 [String, nil] - # # @param state [String] - # # @param zip [String] - # # - # def initialize(city:, line1:, line2:, state:, zip:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(city:, line1:, line2:, state:, zip:) + # The corporation's address. + # + # @param city [String] + # @param line1 [String] + # @param line2 [String, nil] + # @param state [String] + # @param zip [String] end class BeneficialOwner < Increase::Internal::Type::BaseModel @@ -285,15 +254,11 @@ class BeneficialOwner < Increase::Internal::Type::BaseModel # @return [Symbol, Increase::Models::Entity::Corporation::BeneficialOwner::Prong] required :prong, enum: -> { Increase::Models::Entity::Corporation::BeneficialOwner::Prong } - # @!parse - # # @param beneficial_owner_id [String] - # # @param company_title [String, nil] - # # @param individual [Increase::Models::Entity::Corporation::BeneficialOwner::Individual] - # # @param prong [Symbol, Increase::Models::Entity::Corporation::BeneficialOwner::Prong] - # # - # def initialize(beneficial_owner_id:, company_title:, individual:, prong:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(beneficial_owner_id:, company_title:, individual:, prong:) + # @param beneficial_owner_id [String] + # @param company_title [String, nil] + # @param individual [Increase::Models::Entity::Corporation::BeneficialOwner::Individual] + # @param prong [Symbol, Increase::Models::Entity::Corporation::BeneficialOwner::Prong] # @see Increase::Models::Entity::Corporation::BeneficialOwner#individual class Individual < Increase::Internal::Type::BaseModel @@ -322,17 +287,13 @@ class Individual < Increase::Internal::Type::BaseModel # @return [String] required :name, String - # @!parse - # # Personal details for the beneficial owner. - # # - # # @param address [Increase::Models::Entity::Corporation::BeneficialOwner::Individual::Address] - # # @param date_of_birth [Date] - # # @param identification [Increase::Models::Entity::Corporation::BeneficialOwner::Individual::Identification] - # # @param name [String] - # # - # def initialize(address:, date_of_birth:, identification:, name:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(address:, date_of_birth:, identification:, name:) + # Personal details for the beneficial owner. + # + # @param address [Increase::Models::Entity::Corporation::BeneficialOwner::Individual::Address] + # @param date_of_birth [Date] + # @param identification [Increase::Models::Entity::Corporation::BeneficialOwner::Individual::Identification] + # @param name [String] # @see Increase::Models::Entity::Corporation::BeneficialOwner::Individual#address class Address < Increase::Internal::Type::BaseModel @@ -373,19 +334,15 @@ class Address < Increase::Internal::Type::BaseModel # @return [String, nil] required :zip, String, nil?: true - # @!parse - # # The person's address. - # # - # # @param city [String, nil] - # # @param country [String] - # # @param line1 [String] - # # @param line2 [String, nil] - # # @param state [String, nil] - # # @param zip [String, nil] - # # - # def initialize(city:, country:, line1:, line2:, state:, zip:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(city:, country:, line1:, line2:, state:, zip:) + # The person's address. + # + # @param city [String, nil] + # @param country [String] + # @param line1 [String] + # @param line2 [String, nil] + # @param state [String, nil] + # @param zip [String, nil] end # @see Increase::Models::Entity::Corporation::BeneficialOwner::Individual#identification @@ -405,15 +362,11 @@ class Identification < Increase::Internal::Type::BaseModel # @return [String] required :number_last4, String - # @!parse - # # A means of verifying the person's identity. - # # - # # @param method_ [Symbol, Increase::Models::Entity::Corporation::BeneficialOwner::Individual::Identification::Method] - # # @param number_last4 [String] - # # - # def initialize(method_:, number_last4:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(method_:, number_last4:) + # A means of verifying the person's identity. + # + # @param method_ [Symbol, Increase::Models::Entity::Corporation::BeneficialOwner::Individual::Identification::Method] + # @param number_last4 [String] # A method that can be used to verify the individual's identity. # @@ -436,11 +389,8 @@ module Method # Another identifying document. OTHER = :other - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -457,11 +407,8 @@ module Prong # A person who manages, directs, or has significant control of the entity. CONTROL = :control - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -505,20 +452,16 @@ class GovernmentAuthority < Increase::Internal::Type::BaseModel # @return [String, nil] required :website, String, nil?: true - # @!parse - # # Details of the government authority entity. Will be present if `structure` is - # # equal to `government_authority`. - # # - # # @param address [Increase::Models::Entity::GovernmentAuthority::Address] - # # @param authorized_persons [Array] - # # @param category [Symbol, Increase::Models::Entity::GovernmentAuthority::Category] - # # @param name [String] - # # @param tax_identifier [String, nil] - # # @param website [String, nil] - # # - # def initialize(address:, authorized_persons:, category:, name:, tax_identifier:, website:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(address:, authorized_persons:, category:, name:, tax_identifier:, website:) + # Details of the government authority entity. Will be present if `structure` is + # equal to `government_authority`. + # + # @param address [Increase::Models::Entity::GovernmentAuthority::Address] + # @param authorized_persons [Array] + # @param category [Symbol, Increase::Models::Entity::GovernmentAuthority::Category] + # @param name [String] + # @param tax_identifier [String, nil] + # @param website [String, nil] # @see Increase::Models::Entity::GovernmentAuthority#address class Address < Increase::Internal::Type::BaseModel @@ -553,18 +496,14 @@ class Address < Increase::Internal::Type::BaseModel # @return [String] required :zip, String - # @!parse - # # The government authority's address. - # # - # # @param city [String] - # # @param line1 [String] - # # @param line2 [String, nil] - # # @param state [String] - # # @param zip [String] - # # - # def initialize(city:, line1:, line2:, state:, zip:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(city:, line1:, line2:, state:, zip:) + # The government authority's address. + # + # @param city [String] + # @param line1 [String] + # @param line2 [String, nil] + # @param state [String] + # @param zip [String] end class AuthorizedPerson < Increase::Internal::Type::BaseModel @@ -580,13 +519,9 @@ class AuthorizedPerson < Increase::Internal::Type::BaseModel # @return [String] required :name, String - # @!parse - # # @param authorized_person_id [String] - # # @param name [String] - # # - # def initialize(authorized_person_id:, name:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(authorized_person_id:, name:) + # @param authorized_person_id [String] + # @param name [String] end # The category of the government authority. @@ -598,11 +533,8 @@ module Category # The Public Entity is a Municipality. MUNICIPALITY = :municipality - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -621,15 +553,11 @@ class Joint < Increase::Internal::Type::BaseModel # @return [String] required :name, String - # @!parse - # # Details of the joint entity. Will be present if `structure` is equal to `joint`. - # # - # # @param individuals [Array] - # # @param name [String] - # # - # def initialize(individuals:, name:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(individuals:, name:) + # Details of the joint entity. Will be present if `structure` is equal to `joint`. + # + # @param individuals [Array] + # @param name [String] class Individual < Increase::Internal::Type::BaseModel # @!attribute address @@ -656,15 +584,11 @@ class Individual < Increase::Internal::Type::BaseModel # @return [String] required :name, String - # @!parse - # # @param address [Increase::Models::Entity::Joint::Individual::Address] - # # @param date_of_birth [Date] - # # @param identification [Increase::Models::Entity::Joint::Individual::Identification] - # # @param name [String] - # # - # def initialize(address:, date_of_birth:, identification:, name:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(address:, date_of_birth:, identification:, name:) + # @param address [Increase::Models::Entity::Joint::Individual::Address] + # @param date_of_birth [Date] + # @param identification [Increase::Models::Entity::Joint::Individual::Identification] + # @param name [String] # @see Increase::Models::Entity::Joint::Individual#address class Address < Increase::Internal::Type::BaseModel @@ -699,18 +623,14 @@ class Address < Increase::Internal::Type::BaseModel # @return [String] required :zip, String - # @!parse - # # The person's address. - # # - # # @param city [String] - # # @param line1 [String] - # # @param line2 [String, nil] - # # @param state [String] - # # @param zip [String] - # # - # def initialize(city:, line1:, line2:, state:, zip:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(city:, line1:, line2:, state:, zip:) + # The person's address. + # + # @param city [String] + # @param line1 [String] + # @param line2 [String, nil] + # @param state [String] + # @param zip [String] end # @see Increase::Models::Entity::Joint::Individual#identification @@ -730,15 +650,11 @@ class Identification < Increase::Internal::Type::BaseModel # @return [String] required :number_last4, String - # @!parse - # # A means of verifying the person's identity. - # # - # # @param method_ [Symbol, Increase::Models::Entity::Joint::Individual::Identification::Method] - # # @param number_last4 [String] - # # - # def initialize(method_:, number_last4:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(method_:, number_last4:) + # A means of verifying the person's identity. + # + # @param method_ [Symbol, Increase::Models::Entity::Joint::Individual::Identification::Method] + # @param number_last4 [String] # A method that can be used to verify the individual's identity. # @@ -761,11 +677,8 @@ module Method # Another identifying document. OTHER = :other - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -797,18 +710,14 @@ class NaturalPerson < Increase::Internal::Type::BaseModel # @return [String] required :name, String - # @!parse - # # Details of the natural person entity. Will be present if `structure` is equal to - # # `natural_person`. - # # - # # @param address [Increase::Models::Entity::NaturalPerson::Address] - # # @param date_of_birth [Date] - # # @param identification [Increase::Models::Entity::NaturalPerson::Identification] - # # @param name [String] - # # - # def initialize(address:, date_of_birth:, identification:, name:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(address:, date_of_birth:, identification:, name:) + # Details of the natural person entity. Will be present if `structure` is equal to + # `natural_person`. + # + # @param address [Increase::Models::Entity::NaturalPerson::Address] + # @param date_of_birth [Date] + # @param identification [Increase::Models::Entity::NaturalPerson::Identification] + # @param name [String] # @see Increase::Models::Entity::NaturalPerson#address class Address < Increase::Internal::Type::BaseModel @@ -843,18 +752,14 @@ class Address < Increase::Internal::Type::BaseModel # @return [String] required :zip, String - # @!parse - # # The person's address. - # # - # # @param city [String] - # # @param line1 [String] - # # @param line2 [String, nil] - # # @param state [String] - # # @param zip [String] - # # - # def initialize(city:, line1:, line2:, state:, zip:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(city:, line1:, line2:, state:, zip:) + # The person's address. + # + # @param city [String] + # @param line1 [String] + # @param line2 [String, nil] + # @param state [String] + # @param zip [String] end # @see Increase::Models::Entity::NaturalPerson#identification @@ -874,15 +779,11 @@ class Identification < Increase::Internal::Type::BaseModel # @return [String] required :number_last4, String - # @!parse - # # A means of verifying the person's identity. - # # - # # @param method_ [Symbol, Increase::Models::Entity::NaturalPerson::Identification::Method] - # # @param number_last4 [String] - # # - # def initialize(method_:, number_last4:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(method_:, number_last4:) + # A means of verifying the person's identity. + # + # @param method_ [Symbol, Increase::Models::Entity::NaturalPerson::Identification::Method] + # @param number_last4 [String] # A method that can be used to verify the individual's identity. # @@ -905,11 +806,8 @@ module Method # Another identifying document. OTHER = :other - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -929,11 +827,8 @@ module Status # The entity is temporarily disabled and cannot be used for financial activity. DISABLED = :disabled - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # The entity's legal structure. @@ -957,11 +852,8 @@ module Structure # A government authority. GOVERNMENT_AUTHORITY = :government_authority - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Increase::Models::Entity#third_party_verification @@ -978,16 +870,12 @@ class ThirdPartyVerification < Increase::Internal::Type::BaseModel # @return [Symbol, Increase::Models::Entity::ThirdPartyVerification::Vendor] required :vendor, enum: -> { Increase::Models::Entity::ThirdPartyVerification::Vendor } - # @!parse - # # A reference to data stored in a third-party verification service. Your - # # integration may or may not use this field. - # # - # # @param reference [String] - # # @param vendor [Symbol, Increase::Models::Entity::ThirdPartyVerification::Vendor] - # # - # def initialize(reference:, vendor:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(reference:, vendor:) + # A reference to data stored in a third-party verification service. Your + # integration may or may not use this field. + # + # @param reference [String] + # @param vendor [Symbol, Increase::Models::Entity::ThirdPartyVerification::Vendor] # The vendor that was used to perform the verification. # @@ -1001,11 +889,8 @@ module Vendor # Middesk. See https://middesk.com for more information. MIDDESK = :middesk - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -1060,33 +945,17 @@ class Trust < Increase::Internal::Type::BaseModel # @return [Array] required :trustees, -> { Increase::Internal::Type::ArrayOf[Increase::Models::Entity::Trust::Trustee] } - # @!parse - # # Details of the trust entity. Will be present if `structure` is equal to `trust`. - # # - # # @param address [Increase::Models::Entity::Trust::Address] - # # @param category [Symbol, Increase::Models::Entity::Trust::Category] - # # @param formation_document_file_id [String, nil] - # # @param formation_state [String, nil] - # # @param grantor [Increase::Models::Entity::Trust::Grantor, nil] - # # @param name [String] - # # @param tax_identifier [String, nil] - # # @param trustees [Array] - # # - # def initialize( - # address:, - # category:, - # formation_document_file_id:, - # formation_state:, - # grantor:, - # name:, - # tax_identifier:, - # trustees:, - # ** - # ) - # super - # end - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(address:, category:, formation_document_file_id:, formation_state:, grantor:, name:, tax_identifier:, trustees:) + # Details of the trust entity. Will be present if `structure` is equal to `trust`. + # + # @param address [Increase::Models::Entity::Trust::Address] + # @param category [Symbol, Increase::Models::Entity::Trust::Category] + # @param formation_document_file_id [String, nil] + # @param formation_state [String, nil] + # @param grantor [Increase::Models::Entity::Trust::Grantor, nil] + # @param name [String] + # @param tax_identifier [String, nil] + # @param trustees [Array] # @see Increase::Models::Entity::Trust#address class Address < Increase::Internal::Type::BaseModel @@ -1121,18 +990,14 @@ class Address < Increase::Internal::Type::BaseModel # @return [String] required :zip, String - # @!parse - # # The trust's address. - # # - # # @param city [String] - # # @param line1 [String] - # # @param line2 [String, nil] - # # @param state [String] - # # @param zip [String] - # # - # def initialize(city:, line1:, line2:, state:, zip:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(city:, line1:, line2:, state:, zip:) + # The trust's address. + # + # @param city [String] + # @param line1 [String] + # @param line2 [String, nil] + # @param state [String] + # @param zip [String] end # Whether the trust is `revocable` or `irrevocable`. @@ -1147,11 +1012,8 @@ module Category # The trust cannot be revoked. IRREVOCABLE = :irrevocable - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Increase::Models::Entity::Trust#grantor @@ -1180,17 +1042,13 @@ class Grantor < Increase::Internal::Type::BaseModel # @return [String] required :name, String - # @!parse - # # The grantor of the trust. Will be present if the `category` is `revocable`. - # # - # # @param address [Increase::Models::Entity::Trust::Grantor::Address] - # # @param date_of_birth [Date] - # # @param identification [Increase::Models::Entity::Trust::Grantor::Identification] - # # @param name [String] - # # - # def initialize(address:, date_of_birth:, identification:, name:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(address:, date_of_birth:, identification:, name:) + # The grantor of the trust. Will be present if the `category` is `revocable`. + # + # @param address [Increase::Models::Entity::Trust::Grantor::Address] + # @param date_of_birth [Date] + # @param identification [Increase::Models::Entity::Trust::Grantor::Identification] + # @param name [String] # @see Increase::Models::Entity::Trust::Grantor#address class Address < Increase::Internal::Type::BaseModel @@ -1225,18 +1083,14 @@ class Address < Increase::Internal::Type::BaseModel # @return [String] required :zip, String - # @!parse - # # The person's address. - # # - # # @param city [String] - # # @param line1 [String] - # # @param line2 [String, nil] - # # @param state [String] - # # @param zip [String] - # # - # def initialize(city:, line1:, line2:, state:, zip:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(city:, line1:, line2:, state:, zip:) + # The person's address. + # + # @param city [String] + # @param line1 [String] + # @param line2 [String, nil] + # @param state [String] + # @param zip [String] end # @see Increase::Models::Entity::Trust::Grantor#identification @@ -1256,15 +1110,11 @@ class Identification < Increase::Internal::Type::BaseModel # @return [String] required :number_last4, String - # @!parse - # # A means of verifying the person's identity. - # # - # # @param method_ [Symbol, Increase::Models::Entity::Trust::Grantor::Identification::Method] - # # @param number_last4 [String] - # # - # def initialize(method_:, number_last4:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(method_:, number_last4:) + # A means of verifying the person's identity. + # + # @param method_ [Symbol, Increase::Models::Entity::Trust::Grantor::Identification::Method] + # @param number_last4 [String] # A method that can be used to verify the individual's identity. # @@ -1287,11 +1137,8 @@ module Method # Another identifying document. OTHER = :other - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -1310,13 +1157,9 @@ class Trustee < Increase::Internal::Type::BaseModel # @return [Symbol, Increase::Models::Entity::Trust::Trustee::Structure] required :structure, enum: -> { Increase::Models::Entity::Trust::Trustee::Structure } - # @!parse - # # @param individual [Increase::Models::Entity::Trust::Trustee::Individual, nil] - # # @param structure [Symbol, Increase::Models::Entity::Trust::Trustee::Structure] - # # - # def initialize(individual:, structure:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(individual:, structure:) + # @param individual [Increase::Models::Entity::Trust::Trustee::Individual, nil] + # @param structure [Symbol, Increase::Models::Entity::Trust::Trustee::Structure] # @see Increase::Models::Entity::Trust::Trustee#individual class Individual < Increase::Internal::Type::BaseModel @@ -1344,18 +1187,14 @@ class Individual < Increase::Internal::Type::BaseModel # @return [String] required :name, String - # @!parse - # # The individual trustee of the trust. Will be present if the trustee's - # # `structure` is equal to `individual`. - # # - # # @param address [Increase::Models::Entity::Trust::Trustee::Individual::Address] - # # @param date_of_birth [Date] - # # @param identification [Increase::Models::Entity::Trust::Trustee::Individual::Identification] - # # @param name [String] - # # - # def initialize(address:, date_of_birth:, identification:, name:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(address:, date_of_birth:, identification:, name:) + # The individual trustee of the trust. Will be present if the trustee's + # `structure` is equal to `individual`. + # + # @param address [Increase::Models::Entity::Trust::Trustee::Individual::Address] + # @param date_of_birth [Date] + # @param identification [Increase::Models::Entity::Trust::Trustee::Individual::Identification] + # @param name [String] # @see Increase::Models::Entity::Trust::Trustee::Individual#address class Address < Increase::Internal::Type::BaseModel @@ -1390,18 +1229,14 @@ class Address < Increase::Internal::Type::BaseModel # @return [String] required :zip, String - # @!parse - # # The person's address. - # # - # # @param city [String] - # # @param line1 [String] - # # @param line2 [String, nil] - # # @param state [String] - # # @param zip [String] - # # - # def initialize(city:, line1:, line2:, state:, zip:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(city:, line1:, line2:, state:, zip:) + # The person's address. + # + # @param city [String] + # @param line1 [String] + # @param line2 [String, nil] + # @param state [String] + # @param zip [String] end # @see Increase::Models::Entity::Trust::Trustee::Individual#identification @@ -1421,15 +1256,11 @@ class Identification < Increase::Internal::Type::BaseModel # @return [String] required :number_last4, String - # @!parse - # # A means of verifying the person's identity. - # # - # # @param method_ [Symbol, Increase::Models::Entity::Trust::Trustee::Individual::Identification::Method] - # # @param number_last4 [String] - # # - # def initialize(method_:, number_last4:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(method_:, number_last4:) + # A means of verifying the person's identity. + # + # @param method_ [Symbol, Increase::Models::Entity::Trust::Trustee::Individual::Identification::Method] + # @param number_last4 [String] # A method that can be used to verify the individual's identity. # @@ -1452,11 +1283,8 @@ module Method # Another identifying document. OTHER = :other - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -1470,11 +1298,8 @@ module Structure # The trustee is an individual. INDIVIDUAL = :individual - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -1488,11 +1313,8 @@ module Type ENTITY = :entity - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end diff --git a/lib/increase/models/entity_archive_beneficial_owner_params.rb b/lib/increase/models/entity_archive_beneficial_owner_params.rb index 1def60371..56673ce37 100644 --- a/lib/increase/models/entity_archive_beneficial_owner_params.rb +++ b/lib/increase/models/entity_archive_beneficial_owner_params.rb @@ -4,8 +4,7 @@ module Increase module Models # @see Increase::Resources::Entities#archive_beneficial_owner class EntityArchiveBeneficialOwnerParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters # @!attribute beneficial_owner_id @@ -15,13 +14,9 @@ class EntityArchiveBeneficialOwnerParams < Increase::Internal::Type::BaseModel # @return [String] required :beneficial_owner_id, String - # @!parse - # # @param beneficial_owner_id [String] - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(beneficial_owner_id:, request_options: {}, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(beneficial_owner_id:, request_options: {}) + # @param beneficial_owner_id [String] + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/increase/models/entity_archive_params.rb b/lib/increase/models/entity_archive_params.rb index 6465227a7..5c8e1939d 100644 --- a/lib/increase/models/entity_archive_params.rb +++ b/lib/increase/models/entity_archive_params.rb @@ -4,16 +4,11 @@ module Increase module Models # @see Increase::Resources::Entities#archive class EntityArchiveParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters - # @!parse - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(request_options: {}, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(request_options: {}) + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/increase/models/entity_confirm_params.rb b/lib/increase/models/entity_confirm_params.rb index 50453c0c4..cf2afb604 100644 --- a/lib/increase/models/entity_confirm_params.rb +++ b/lib/increase/models/entity_confirm_params.rb @@ -4,28 +4,19 @@ module Increase module Models # @see Increase::Resources::Entities#confirm class EntityConfirmParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters - # @!attribute [r] confirmed_at + # @!attribute confirmed_at # When your user confirmed the Entity's details. If not provided, the current time # will be used. # # @return [Time, nil] optional :confirmed_at, Time - # @!parse - # # @return [Time] - # attr_writer :confirmed_at - - # @!parse - # # @param confirmed_at [Time] - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(confirmed_at: nil, request_options: {}, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(confirmed_at: nil, request_options: {}) + # @param confirmed_at [Time] + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/increase/models/entity_create_beneficial_owner_params.rb b/lib/increase/models/entity_create_beneficial_owner_params.rb index 5221a86af..5f21ee5ab 100644 --- a/lib/increase/models/entity_create_beneficial_owner_params.rb +++ b/lib/increase/models/entity_create_beneficial_owner_params.rb @@ -4,8 +4,7 @@ module Increase module Models # @see Increase::Resources::Entities#create_beneficial_owner class EntityCreateBeneficialOwnerParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters # @!attribute beneficial_owner @@ -15,13 +14,9 @@ class EntityCreateBeneficialOwnerParams < Increase::Internal::Type::BaseModel # @return [Increase::Models::EntityCreateBeneficialOwnerParams::BeneficialOwner] required :beneficial_owner, -> { Increase::Models::EntityCreateBeneficialOwnerParams::BeneficialOwner } - # @!parse - # # @param beneficial_owner [Increase::Models::EntityCreateBeneficialOwnerParams::BeneficialOwner] - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(beneficial_owner:, request_options: {}, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(beneficial_owner:, request_options: {}) + # @param beneficial_owner [Increase::Models::EntityCreateBeneficialOwnerParams::BeneficialOwner] + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] class BeneficialOwner < Increase::Internal::Type::BaseModel # @!attribute individual @@ -40,27 +35,19 @@ class BeneficialOwner < Increase::Internal::Type::BaseModel required :prongs, -> { Increase::Internal::Type::ArrayOf[enum: Increase::Models::EntityCreateBeneficialOwnerParams::BeneficialOwner::Prong] } - # @!attribute [r] company_title + # @!attribute company_title # This person's role or title within the entity. # # @return [String, nil] optional :company_title, String - # @!parse - # # @return [String] - # attr_writer :company_title - - # @!parse - # # The identifying details of anyone controlling or owning 25% or more of the - # # corporation. - # # - # # @param individual [Increase::Models::EntityCreateBeneficialOwnerParams::BeneficialOwner::Individual] - # # @param prongs [Array] - # # @param company_title [String] - # # - # def initialize(individual:, prongs:, company_title: nil, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(individual:, prongs:, company_title: nil) + # The identifying details of anyone controlling or owning 25% or more of the + # corporation. + # + # @param individual [Increase::Models::EntityCreateBeneficialOwnerParams::BeneficialOwner::Individual] + # @param prongs [Array] + # @param company_title [String] # @see Increase::Models::EntityCreateBeneficialOwnerParams::BeneficialOwner#individual class Individual < Increase::Internal::Type::BaseModel @@ -91,7 +78,7 @@ class Individual < Increase::Internal::Type::BaseModel # @return [String] required :name, String - # @!attribute [r] confirmed_no_us_tax_id + # @!attribute confirmed_no_us_tax_id # The identification method for an individual can only be a passport, driver's # license, or other document if you've confirmed the individual does not have a US # tax id (either a Social Security Number or Individual Taxpayer Identification @@ -100,22 +87,14 @@ class Individual < Increase::Internal::Type::BaseModel # @return [Boolean, nil] optional :confirmed_no_us_tax_id, Increase::Internal::Type::Boolean - # @!parse - # # @return [Boolean] - # attr_writer :confirmed_no_us_tax_id - - # @!parse - # # Personal details for the beneficial owner. - # # - # # @param address [Increase::Models::EntityCreateBeneficialOwnerParams::BeneficialOwner::Individual::Address] - # # @param date_of_birth [Date] - # # @param identification [Increase::Models::EntityCreateBeneficialOwnerParams::BeneficialOwner::Individual::Identification] - # # @param name [String] - # # @param confirmed_no_us_tax_id [Boolean] - # # - # def initialize(address:, date_of_birth:, identification:, name:, confirmed_no_us_tax_id: nil, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(address:, date_of_birth:, identification:, name:, confirmed_no_us_tax_id: nil) + # Personal details for the beneficial owner. + # + # @param address [Increase::Models::EntityCreateBeneficialOwnerParams::BeneficialOwner::Individual::Address] + # @param date_of_birth [Date] + # @param identification [Increase::Models::EntityCreateBeneficialOwnerParams::BeneficialOwner::Individual::Identification] + # @param name [String] + # @param confirmed_no_us_tax_id [Boolean] # @see Increase::Models::EntityCreateBeneficialOwnerParams::BeneficialOwner::Individual#address class Address < Increase::Internal::Type::BaseModel @@ -131,62 +110,42 @@ class Address < Increase::Internal::Type::BaseModel # @return [String] required :line1, String - # @!attribute [r] city + # @!attribute city # The city, district, town, or village of the address. Required in certain # countries. # # @return [String, nil] optional :city, String - # @!parse - # # @return [String] - # attr_writer :city - - # @!attribute [r] line2 + # @!attribute line2 # The second line of the address. This might be the floor or room number. # # @return [String, nil] optional :line2, String - # @!parse - # # @return [String] - # attr_writer :line2 - - # @!attribute [r] state + # @!attribute state # The two-letter United States Postal Service (USPS) abbreviation for the US # state, province, or region of the address. Required in certain countries. # # @return [String, nil] optional :state, String - # @!parse - # # @return [String] - # attr_writer :state - - # @!attribute [r] zip + # @!attribute zip # The ZIP or postal code of the address. Required in certain countries. # # @return [String, nil] optional :zip, String - # @!parse - # # @return [String] - # attr_writer :zip - - # @!parse - # # The individual's physical address. Mail receiving locations like PO Boxes and - # # PMB's are disallowed. - # # - # # @param country [String] - # # @param line1 [String] - # # @param city [String] - # # @param line2 [String] - # # @param state [String] - # # @param zip [String] - # # - # def initialize(country:, line1:, city: nil, line2: nil, state: nil, zip: nil, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(country:, line1:, city: nil, line2: nil, state: nil, zip: nil) + # The individual's physical address. Mail receiving locations like PO Boxes and + # PMB's are disallowed. + # + # @param country [String] + # @param line1 [String] + # @param city [String] + # @param line2 [String] + # @param state [String] + # @param zip [String] end # @see Increase::Models::EntityCreateBeneficialOwnerParams::BeneficialOwner::Individual#identification @@ -206,7 +165,7 @@ class Identification < Increase::Internal::Type::BaseModel # @return [String] required :number, String - # @!attribute [r] drivers_license + # @!attribute drivers_license # Information about the United States driver's license used for identification. # Required if `method` is equal to `drivers_license`. # @@ -214,11 +173,7 @@ class Identification < Increase::Internal::Type::BaseModel optional :drivers_license, -> { Increase::Models::EntityCreateBeneficialOwnerParams::BeneficialOwner::Individual::Identification::DriversLicense } - # @!parse - # # @return [Increase::Models::EntityCreateBeneficialOwnerParams::BeneficialOwner::Individual::Identification::DriversLicense] - # attr_writer :drivers_license - - # @!attribute [r] other + # @!attribute other # Information about the identification document provided. Required if `method` is # equal to `other`. # @@ -226,11 +181,7 @@ class Identification < Increase::Internal::Type::BaseModel optional :other, -> { Increase::Models::EntityCreateBeneficialOwnerParams::BeneficialOwner::Individual::Identification::Other } - # @!parse - # # @return [Increase::Models::EntityCreateBeneficialOwnerParams::BeneficialOwner::Individual::Identification::Other] - # attr_writer :other - - # @!attribute [r] passport + # @!attribute passport # Information about the passport used for identification. Required if `method` is # equal to `passport`. # @@ -238,22 +189,14 @@ class Identification < Increase::Internal::Type::BaseModel optional :passport, -> { Increase::Models::EntityCreateBeneficialOwnerParams::BeneficialOwner::Individual::Identification::Passport } - # @!parse - # # @return [Increase::Models::EntityCreateBeneficialOwnerParams::BeneficialOwner::Individual::Identification::Passport] - # attr_writer :passport - - # @!parse - # # A means of verifying the person's identity. - # # - # # @param method_ [Symbol, Increase::Models::EntityCreateBeneficialOwnerParams::BeneficialOwner::Individual::Identification::Method] - # # @param number [String] - # # @param drivers_license [Increase::Models::EntityCreateBeneficialOwnerParams::BeneficialOwner::Individual::Identification::DriversLicense] - # # @param other [Increase::Models::EntityCreateBeneficialOwnerParams::BeneficialOwner::Individual::Identification::Other] - # # @param passport [Increase::Models::EntityCreateBeneficialOwnerParams::BeneficialOwner::Individual::Identification::Passport] - # # - # def initialize(method_:, number:, drivers_license: nil, other: nil, passport: nil, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(method_:, number:, drivers_license: nil, other: nil, passport: nil) + # A means of verifying the person's identity. + # + # @param method_ [Symbol, Increase::Models::EntityCreateBeneficialOwnerParams::BeneficialOwner::Individual::Identification::Method] + # @param number [String] + # @param drivers_license [Increase::Models::EntityCreateBeneficialOwnerParams::BeneficialOwner::Individual::Identification::DriversLicense] + # @param other [Increase::Models::EntityCreateBeneficialOwnerParams::BeneficialOwner::Individual::Identification::Other] + # @param passport [Increase::Models::EntityCreateBeneficialOwnerParams::BeneficialOwner::Individual::Identification::Passport] # A method that can be used to verify the individual's identity. # @@ -276,11 +219,8 @@ module Method # Another identifying document. OTHER = :other - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Increase::Models::EntityCreateBeneficialOwnerParams::BeneficialOwner::Individual::Identification#drivers_license @@ -303,28 +243,20 @@ class DriversLicense < Increase::Internal::Type::BaseModel # @return [String] required :state, String - # @!attribute [r] back_file_id + # @!attribute back_file_id # The identifier of the File containing the back of the driver's license. # # @return [String, nil] optional :back_file_id, String - # @!parse - # # @return [String] - # attr_writer :back_file_id - - # @!parse - # # Information about the United States driver's license used for identification. - # # Required if `method` is equal to `drivers_license`. - # # - # # @param expiration_date [Date] - # # @param file_id [String] - # # @param state [String] - # # @param back_file_id [String] - # # - # def initialize(expiration_date:, file_id:, state:, back_file_id: nil, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(expiration_date:, file_id:, state:, back_file_id: nil) + # Information about the United States driver's license used for identification. + # Required if `method` is equal to `drivers_license`. + # + # @param expiration_date [Date] + # @param file_id [String] + # @param state [String] + # @param back_file_id [String] end # @see Increase::Models::EntityCreateBeneficialOwnerParams::BeneficialOwner::Individual::Identification#other @@ -348,40 +280,28 @@ class Other < Increase::Internal::Type::BaseModel # @return [String] required :file_id, String - # @!attribute [r] back_file_id + # @!attribute back_file_id # The identifier of the File containing the back of the document. Not every # document has a reverse side. # # @return [String, nil] optional :back_file_id, String - # @!parse - # # @return [String] - # attr_writer :back_file_id - - # @!attribute [r] expiration_date + # @!attribute expiration_date # The document's expiration date in YYYY-MM-DD format. # # @return [Date, nil] optional :expiration_date, Date - # @!parse - # # @return [Date] - # attr_writer :expiration_date - - # @!parse - # # Information about the identification document provided. Required if `method` is - # # equal to `other`. - # # - # # @param country [String] - # # @param description [String] - # # @param file_id [String] - # # @param back_file_id [String] - # # @param expiration_date [Date] - # # - # def initialize(country:, description:, file_id:, back_file_id: nil, expiration_date: nil, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(country:, description:, file_id:, back_file_id: nil, expiration_date: nil) + # Information about the identification document provided. Required if `method` is + # equal to `other`. + # + # @param country [String] + # @param description [String] + # @param file_id [String] + # @param back_file_id [String] + # @param expiration_date [Date] end # @see Increase::Models::EntityCreateBeneficialOwnerParams::BeneficialOwner::Individual::Identification#passport @@ -404,17 +324,13 @@ class Passport < Increase::Internal::Type::BaseModel # @return [String] required :file_id, String - # @!parse - # # Information about the passport used for identification. Required if `method` is - # # equal to `passport`. - # # - # # @param country [String] - # # @param expiration_date [Date] - # # @param file_id [String] - # # - # def initialize(country:, expiration_date:, file_id:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(country:, expiration_date:, file_id:) + # Information about the passport used for identification. Required if `method` is + # equal to `passport`. + # + # @param country [String] + # @param expiration_date [Date] + # @param file_id [String] end end end @@ -428,11 +344,8 @@ module Prong # A person who manages, directs, or has significant control of the entity. CONTROL = :control - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end diff --git a/lib/increase/models/entity_create_params.rb b/lib/increase/models/entity_create_params.rb index 3070a0a7e..281167439 100644 --- a/lib/increase/models/entity_create_params.rb +++ b/lib/increase/models/entity_create_params.rb @@ -4,8 +4,7 @@ module Increase module Models # @see Increase::Resources::Entities#create class EntityCreateParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters # @!attribute structure @@ -14,50 +13,34 @@ class EntityCreateParams < Increase::Internal::Type::BaseModel # @return [Symbol, Increase::Models::EntityCreateParams::Structure] required :structure, enum: -> { Increase::Models::EntityCreateParams::Structure } - # @!attribute [r] corporation + # @!attribute corporation # Details of the corporation entity to create. Required if `structure` is equal to # `corporation`. # # @return [Increase::Models::EntityCreateParams::Corporation, nil] optional :corporation, -> { Increase::Models::EntityCreateParams::Corporation } - # @!parse - # # @return [Increase::Models::EntityCreateParams::Corporation] - # attr_writer :corporation - - # @!attribute [r] description + # @!attribute description # The description you choose to give the entity. # # @return [String, nil] optional :description, String - # @!parse - # # @return [String] - # attr_writer :description - - # @!attribute [r] government_authority + # @!attribute government_authority # Details of the Government Authority entity to create. Required if `structure` is # equal to `Government Authority`. # # @return [Increase::Models::EntityCreateParams::GovernmentAuthority, nil] optional :government_authority, -> { Increase::Models::EntityCreateParams::GovernmentAuthority } - # @!parse - # # @return [Increase::Models::EntityCreateParams::GovernmentAuthority] - # attr_writer :government_authority - - # @!attribute [r] joint + # @!attribute joint # Details of the joint entity to create. Required if `structure` is equal to # `joint`. # # @return [Increase::Models::EntityCreateParams::Joint, nil] optional :joint, -> { Increase::Models::EntityCreateParams::Joint } - # @!parse - # # @return [Increase::Models::EntityCreateParams::Joint] - # attr_writer :joint - - # @!attribute [r] natural_person + # @!attribute natural_person # Details of the natural person entity to create. Required if `structure` is equal # to `natural_person`. Natural people entities should be submitted with # `social_security_number` or `individual_taxpayer_identification_number` @@ -66,72 +49,38 @@ class EntityCreateParams < Increase::Internal::Type::BaseModel # @return [Increase::Models::EntityCreateParams::NaturalPerson, nil] optional :natural_person, -> { Increase::Models::EntityCreateParams::NaturalPerson } - # @!parse - # # @return [Increase::Models::EntityCreateParams::NaturalPerson] - # attr_writer :natural_person - - # @!attribute [r] supplemental_documents + # @!attribute supplemental_documents # Additional documentation associated with the entity. # # @return [Array, nil] optional :supplemental_documents, -> { Increase::Internal::Type::ArrayOf[Increase::Models::EntityCreateParams::SupplementalDocument] } - # @!parse - # # @return [Array] - # attr_writer :supplemental_documents - - # @!attribute [r] third_party_verification + # @!attribute third_party_verification # A reference to data stored in a third-party verification service. Your # integration may or may not use this field. # # @return [Increase::Models::EntityCreateParams::ThirdPartyVerification, nil] optional :third_party_verification, -> { Increase::Models::EntityCreateParams::ThirdPartyVerification } - # @!parse - # # @return [Increase::Models::EntityCreateParams::ThirdPartyVerification] - # attr_writer :third_party_verification - - # @!attribute [r] trust + # @!attribute trust # Details of the trust entity to create. Required if `structure` is equal to # `trust`. # # @return [Increase::Models::EntityCreateParams::Trust, nil] optional :trust, -> { Increase::Models::EntityCreateParams::Trust } - # @!parse - # # @return [Increase::Models::EntityCreateParams::Trust] - # attr_writer :trust - - # @!parse - # # @param structure [Symbol, Increase::Models::EntityCreateParams::Structure] - # # @param corporation [Increase::Models::EntityCreateParams::Corporation] - # # @param description [String] - # # @param government_authority [Increase::Models::EntityCreateParams::GovernmentAuthority] - # # @param joint [Increase::Models::EntityCreateParams::Joint] - # # @param natural_person [Increase::Models::EntityCreateParams::NaturalPerson] - # # @param supplemental_documents [Array] - # # @param third_party_verification [Increase::Models::EntityCreateParams::ThirdPartyVerification] - # # @param trust [Increase::Models::EntityCreateParams::Trust] - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize( - # structure:, - # corporation: nil, - # description: nil, - # government_authority: nil, - # joint: nil, - # natural_person: nil, - # supplemental_documents: nil, - # third_party_verification: nil, - # trust: nil, - # request_options: {}, - # ** - # ) - # super - # end - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(structure:, corporation: nil, description: nil, government_authority: nil, joint: nil, natural_person: nil, supplemental_documents: nil, third_party_verification: nil, trust: nil, request_options: {}) + # @param structure [Symbol, Increase::Models::EntityCreateParams::Structure] + # @param corporation [Increase::Models::EntityCreateParams::Corporation] + # @param description [String] + # @param government_authority [Increase::Models::EntityCreateParams::GovernmentAuthority] + # @param joint [Increase::Models::EntityCreateParams::Joint] + # @param natural_person [Increase::Models::EntityCreateParams::NaturalPerson] + # @param supplemental_documents [Array] + # @param third_party_verification [Increase::Models::EntityCreateParams::ThirdPartyVerification] + # @param trust [Increase::Models::EntityCreateParams::Trust] + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] # The type of Entity to create. module Structure @@ -152,11 +101,8 @@ module Structure # A government authority. GOVERNMENT_AUTHORITY = :government_authority - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end class Corporation < Increase::Internal::Type::BaseModel @@ -168,8 +114,9 @@ class Corporation < Increase::Internal::Type::BaseModel required :address, -> { Increase::Models::EntityCreateParams::Corporation::Address } # @!attribute beneficial_owners - # The identifying details of anyone controlling or owning 25% or more of the - # corporation. + # The identifying details of each person who owns 25% or more of the business and + # one control person, like the CEO, CFO, or other executive. You can submit + # between 1 and 5 people to this list. # # @return [Array] required :beneficial_owners, @@ -187,18 +134,23 @@ class Corporation < Increase::Internal::Type::BaseModel # @return [String] required :tax_identifier, String - # @!attribute [r] incorporation_state + # @!attribute beneficial_ownership_exemption_reason + # If the entity is exempt from the requirement to submit beneficial owners, + # provide the justification. If a reason is provided, you do not need to submit a + # list of beneficial owners. + # + # @return [Symbol, Increase::Models::EntityCreateParams::Corporation::BeneficialOwnershipExemptionReason, nil] + optional :beneficial_ownership_exemption_reason, + enum: -> { Increase::Models::EntityCreateParams::Corporation::BeneficialOwnershipExemptionReason } + + # @!attribute incorporation_state # The two-letter United States Postal Service (USPS) abbreviation for the # corporation's state of incorporation. # # @return [String, nil] optional :incorporation_state, String - # @!parse - # # @return [String] - # attr_writer :incorporation_state - - # @!attribute [r] industry_code + # @!attribute industry_code # The North American Industry Classification System (NAICS) code for the # corporation's primary line of business. This is a number, like `5132` for # `Software Publishers`. A full list of classification codes is available @@ -207,46 +159,24 @@ class Corporation < Increase::Internal::Type::BaseModel # @return [String, nil] optional :industry_code, String - # @!parse - # # @return [String] - # attr_writer :industry_code - - # @!attribute [r] website + # @!attribute website # The website of the corporation. # # @return [String, nil] optional :website, String - # @!parse - # # @return [String] - # attr_writer :website - - # @!parse - # # Details of the corporation entity to create. Required if `structure` is equal to - # # `corporation`. - # # - # # @param address [Increase::Models::EntityCreateParams::Corporation::Address] - # # @param beneficial_owners [Array] - # # @param name [String] - # # @param tax_identifier [String] - # # @param incorporation_state [String] - # # @param industry_code [String] - # # @param website [String] - # # - # def initialize( - # address:, - # beneficial_owners:, - # name:, - # tax_identifier:, - # incorporation_state: nil, - # industry_code: nil, - # website: nil, - # ** - # ) - # super - # end - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(address:, beneficial_owners:, name:, tax_identifier:, beneficial_ownership_exemption_reason: nil, incorporation_state: nil, industry_code: nil, website: nil) + # Details of the corporation entity to create. Required if `structure` is equal to + # `corporation`. + # + # @param address [Increase::Models::EntityCreateParams::Corporation::Address] + # @param beneficial_owners [Array] + # @param name [String] + # @param tax_identifier [String] + # @param beneficial_ownership_exemption_reason [Symbol, Increase::Models::EntityCreateParams::Corporation::BeneficialOwnershipExemptionReason] + # @param incorporation_state [String] + # @param industry_code [String] + # @param website [String] # @see Increase::Models::EntityCreateParams::Corporation#address class Address < Increase::Internal::Type::BaseModel @@ -275,29 +205,21 @@ class Address < Increase::Internal::Type::BaseModel # @return [String] required :zip, String - # @!attribute [r] line2 + # @!attribute line2 # The second line of the address. This might be the floor or room number. # # @return [String, nil] optional :line2, String - # @!parse - # # @return [String] - # attr_writer :line2 - - # @!parse - # # The entity's physical address. Mail receiving locations like PO Boxes and PMB's - # # are disallowed. - # # - # # @param city [String] - # # @param line1 [String] - # # @param state [String] - # # @param zip [String] - # # @param line2 [String] - # # - # def initialize(city:, line1:, state:, zip:, line2: nil, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(city:, line1:, state:, zip:, line2: nil) + # The entity's physical address. Mail receiving locations like PO Boxes and PMB's + # are disallowed. + # + # @param city [String] + # @param line1 [String] + # @param state [String] + # @param zip [String] + # @param line2 [String] end class BeneficialOwner < Increase::Internal::Type::BaseModel @@ -317,24 +239,16 @@ class BeneficialOwner < Increase::Internal::Type::BaseModel required :prongs, -> { Increase::Internal::Type::ArrayOf[enum: Increase::Models::EntityCreateParams::Corporation::BeneficialOwner::Prong] } - # @!attribute [r] company_title + # @!attribute company_title # This person's role or title within the entity. # # @return [String, nil] optional :company_title, String - # @!parse - # # @return [String] - # attr_writer :company_title - - # @!parse - # # @param individual [Increase::Models::EntityCreateParams::Corporation::BeneficialOwner::Individual] - # # @param prongs [Array] - # # @param company_title [String] - # # - # def initialize(individual:, prongs:, company_title: nil, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(individual:, prongs:, company_title: nil) + # @param individual [Increase::Models::EntityCreateParams::Corporation::BeneficialOwner::Individual] + # @param prongs [Array] + # @param company_title [String] # @see Increase::Models::EntityCreateParams::Corporation::BeneficialOwner#individual class Individual < Increase::Internal::Type::BaseModel @@ -365,7 +279,7 @@ class Individual < Increase::Internal::Type::BaseModel # @return [String] required :name, String - # @!attribute [r] confirmed_no_us_tax_id + # @!attribute confirmed_no_us_tax_id # The identification method for an individual can only be a passport, driver's # license, or other document if you've confirmed the individual does not have a US # tax id (either a Social Security Number or Individual Taxpayer Identification @@ -374,22 +288,14 @@ class Individual < Increase::Internal::Type::BaseModel # @return [Boolean, nil] optional :confirmed_no_us_tax_id, Increase::Internal::Type::Boolean - # @!parse - # # @return [Boolean] - # attr_writer :confirmed_no_us_tax_id - - # @!parse - # # Personal details for the beneficial owner. - # # - # # @param address [Increase::Models::EntityCreateParams::Corporation::BeneficialOwner::Individual::Address] - # # @param date_of_birth [Date] - # # @param identification [Increase::Models::EntityCreateParams::Corporation::BeneficialOwner::Individual::Identification] - # # @param name [String] - # # @param confirmed_no_us_tax_id [Boolean] - # # - # def initialize(address:, date_of_birth:, identification:, name:, confirmed_no_us_tax_id: nil, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(address:, date_of_birth:, identification:, name:, confirmed_no_us_tax_id: nil) + # Personal details for the beneficial owner. + # + # @param address [Increase::Models::EntityCreateParams::Corporation::BeneficialOwner::Individual::Address] + # @param date_of_birth [Date] + # @param identification [Increase::Models::EntityCreateParams::Corporation::BeneficialOwner::Individual::Identification] + # @param name [String] + # @param confirmed_no_us_tax_id [Boolean] # @see Increase::Models::EntityCreateParams::Corporation::BeneficialOwner::Individual#address class Address < Increase::Internal::Type::BaseModel @@ -405,62 +311,42 @@ class Address < Increase::Internal::Type::BaseModel # @return [String] required :line1, String - # @!attribute [r] city + # @!attribute city # The city, district, town, or village of the address. Required in certain # countries. # # @return [String, nil] optional :city, String - # @!parse - # # @return [String] - # attr_writer :city - - # @!attribute [r] line2 + # @!attribute line2 # The second line of the address. This might be the floor or room number. # # @return [String, nil] optional :line2, String - # @!parse - # # @return [String] - # attr_writer :line2 - - # @!attribute [r] state + # @!attribute state # The two-letter United States Postal Service (USPS) abbreviation for the US # state, province, or region of the address. Required in certain countries. # # @return [String, nil] optional :state, String - # @!parse - # # @return [String] - # attr_writer :state - - # @!attribute [r] zip + # @!attribute zip # The ZIP or postal code of the address. Required in certain countries. # # @return [String, nil] optional :zip, String - # @!parse - # # @return [String] - # attr_writer :zip - - # @!parse - # # The individual's physical address. Mail receiving locations like PO Boxes and - # # PMB's are disallowed. - # # - # # @param country [String] - # # @param line1 [String] - # # @param city [String] - # # @param line2 [String] - # # @param state [String] - # # @param zip [String] - # # - # def initialize(country:, line1:, city: nil, line2: nil, state: nil, zip: nil, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(country:, line1:, city: nil, line2: nil, state: nil, zip: nil) + # The individual's physical address. Mail receiving locations like PO Boxes and + # PMB's are disallowed. + # + # @param country [String] + # @param line1 [String] + # @param city [String] + # @param line2 [String] + # @param state [String] + # @param zip [String] end # @see Increase::Models::EntityCreateParams::Corporation::BeneficialOwner::Individual#identification @@ -480,7 +366,7 @@ class Identification < Increase::Internal::Type::BaseModel # @return [String] required :number, String - # @!attribute [r] drivers_license + # @!attribute drivers_license # Information about the United States driver's license used for identification. # Required if `method` is equal to `drivers_license`. # @@ -488,11 +374,7 @@ class Identification < Increase::Internal::Type::BaseModel optional :drivers_license, -> { Increase::Models::EntityCreateParams::Corporation::BeneficialOwner::Individual::Identification::DriversLicense } - # @!parse - # # @return [Increase::Models::EntityCreateParams::Corporation::BeneficialOwner::Individual::Identification::DriversLicense] - # attr_writer :drivers_license - - # @!attribute [r] other + # @!attribute other # Information about the identification document provided. Required if `method` is # equal to `other`. # @@ -500,11 +382,7 @@ class Identification < Increase::Internal::Type::BaseModel optional :other, -> { Increase::Models::EntityCreateParams::Corporation::BeneficialOwner::Individual::Identification::Other } - # @!parse - # # @return [Increase::Models::EntityCreateParams::Corporation::BeneficialOwner::Individual::Identification::Other] - # attr_writer :other - - # @!attribute [r] passport + # @!attribute passport # Information about the passport used for identification. Required if `method` is # equal to `passport`. # @@ -512,22 +390,14 @@ class Identification < Increase::Internal::Type::BaseModel optional :passport, -> { Increase::Models::EntityCreateParams::Corporation::BeneficialOwner::Individual::Identification::Passport } - # @!parse - # # @return [Increase::Models::EntityCreateParams::Corporation::BeneficialOwner::Individual::Identification::Passport] - # attr_writer :passport - - # @!parse - # # A means of verifying the person's identity. - # # - # # @param method_ [Symbol, Increase::Models::EntityCreateParams::Corporation::BeneficialOwner::Individual::Identification::Method] - # # @param number [String] - # # @param drivers_license [Increase::Models::EntityCreateParams::Corporation::BeneficialOwner::Individual::Identification::DriversLicense] - # # @param other [Increase::Models::EntityCreateParams::Corporation::BeneficialOwner::Individual::Identification::Other] - # # @param passport [Increase::Models::EntityCreateParams::Corporation::BeneficialOwner::Individual::Identification::Passport] - # # - # def initialize(method_:, number:, drivers_license: nil, other: nil, passport: nil, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(method_:, number:, drivers_license: nil, other: nil, passport: nil) + # A means of verifying the person's identity. + # + # @param method_ [Symbol, Increase::Models::EntityCreateParams::Corporation::BeneficialOwner::Individual::Identification::Method] + # @param number [String] + # @param drivers_license [Increase::Models::EntityCreateParams::Corporation::BeneficialOwner::Individual::Identification::DriversLicense] + # @param other [Increase::Models::EntityCreateParams::Corporation::BeneficialOwner::Individual::Identification::Other] + # @param passport [Increase::Models::EntityCreateParams::Corporation::BeneficialOwner::Individual::Identification::Passport] # A method that can be used to verify the individual's identity. # @@ -550,11 +420,8 @@ module Method # Another identifying document. OTHER = :other - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Increase::Models::EntityCreateParams::Corporation::BeneficialOwner::Individual::Identification#drivers_license @@ -577,28 +444,20 @@ class DriversLicense < Increase::Internal::Type::BaseModel # @return [String] required :state, String - # @!attribute [r] back_file_id + # @!attribute back_file_id # The identifier of the File containing the back of the driver's license. # # @return [String, nil] optional :back_file_id, String - # @!parse - # # @return [String] - # attr_writer :back_file_id - - # @!parse - # # Information about the United States driver's license used for identification. - # # Required if `method` is equal to `drivers_license`. - # # - # # @param expiration_date [Date] - # # @param file_id [String] - # # @param state [String] - # # @param back_file_id [String] - # # - # def initialize(expiration_date:, file_id:, state:, back_file_id: nil, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(expiration_date:, file_id:, state:, back_file_id: nil) + # Information about the United States driver's license used for identification. + # Required if `method` is equal to `drivers_license`. + # + # @param expiration_date [Date] + # @param file_id [String] + # @param state [String] + # @param back_file_id [String] end # @see Increase::Models::EntityCreateParams::Corporation::BeneficialOwner::Individual::Identification#other @@ -622,40 +481,28 @@ class Other < Increase::Internal::Type::BaseModel # @return [String] required :file_id, String - # @!attribute [r] back_file_id + # @!attribute back_file_id # The identifier of the File containing the back of the document. Not every # document has a reverse side. # # @return [String, nil] optional :back_file_id, String - # @!parse - # # @return [String] - # attr_writer :back_file_id - - # @!attribute [r] expiration_date + # @!attribute expiration_date # The document's expiration date in YYYY-MM-DD format. # # @return [Date, nil] optional :expiration_date, Date - # @!parse - # # @return [Date] - # attr_writer :expiration_date - - # @!parse - # # Information about the identification document provided. Required if `method` is - # # equal to `other`. - # # - # # @param country [String] - # # @param description [String] - # # @param file_id [String] - # # @param back_file_id [String] - # # @param expiration_date [Date] - # # - # def initialize(country:, description:, file_id:, back_file_id: nil, expiration_date: nil, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(country:, description:, file_id:, back_file_id: nil, expiration_date: nil) + # Information about the identification document provided. Required if `method` is + # equal to `other`. + # + # @param country [String] + # @param description [String] + # @param file_id [String] + # @param back_file_id [String] + # @param expiration_date [Date] end # @see Increase::Models::EntityCreateParams::Corporation::BeneficialOwner::Individual::Identification#passport @@ -678,17 +525,13 @@ class Passport < Increase::Internal::Type::BaseModel # @return [String] required :file_id, String - # @!parse - # # Information about the passport used for identification. Required if `method` is - # # equal to `passport`. - # # - # # @param country [String] - # # @param expiration_date [Date] - # # @param file_id [String] - # # - # def initialize(country:, expiration_date:, file_id:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(country:, expiration_date:, file_id:) + # Information about the passport used for identification. Required if `method` is + # equal to `passport`. + # + # @param country [String] + # @param expiration_date [Date] + # @param file_id [String] end end end @@ -702,13 +545,31 @@ module Prong # A person who manages, directs, or has significant control of the entity. CONTROL = :control - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end + + # If the entity is exempt from the requirement to submit beneficial owners, + # provide the justification. If a reason is provided, you do not need to submit a + # list of beneficial owners. + # + # @see Increase::Models::EntityCreateParams::Corporation#beneficial_ownership_exemption_reason + module BeneficialOwnershipExemptionReason + extend Increase::Internal::Type::Enum + + # A regulated financial institution. + REGULATED_FINANCIAL_INSTITUTION = :regulated_financial_institution + + # A publicly traded company. + PUBLICLY_TRADED_COMPANY = :publicly_traded_company + + # A public entity acting on behalf of the federal or a state government. + PUBLIC_ENTITY = :public_entity + + # @!method self.values + # @return [Array] + end end class GovernmentAuthority < Increase::Internal::Type::BaseModel @@ -744,30 +605,22 @@ class GovernmentAuthority < Increase::Internal::Type::BaseModel # @return [String] required :tax_identifier, String - # @!attribute [r] website + # @!attribute website # The website of the government authority. # # @return [String, nil] optional :website, String - # @!parse - # # @return [String] - # attr_writer :website - - # @!parse - # # Details of the Government Authority entity to create. Required if `structure` is - # # equal to `Government Authority`. - # # - # # @param address [Increase::Models::EntityCreateParams::GovernmentAuthority::Address] - # # @param authorized_persons [Array] - # # @param category [Symbol, Increase::Models::EntityCreateParams::GovernmentAuthority::Category] - # # @param name [String] - # # @param tax_identifier [String] - # # @param website [String] - # # - # def initialize(address:, authorized_persons:, category:, name:, tax_identifier:, website: nil, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(address:, authorized_persons:, category:, name:, tax_identifier:, website: nil) + # Details of the Government Authority entity to create. Required if `structure` is + # equal to `Government Authority`. + # + # @param address [Increase::Models::EntityCreateParams::GovernmentAuthority::Address] + # @param authorized_persons [Array] + # @param category [Symbol, Increase::Models::EntityCreateParams::GovernmentAuthority::Category] + # @param name [String] + # @param tax_identifier [String] + # @param website [String] # @see Increase::Models::EntityCreateParams::GovernmentAuthority#address class Address < Increase::Internal::Type::BaseModel @@ -796,29 +649,21 @@ class Address < Increase::Internal::Type::BaseModel # @return [String] required :zip, String - # @!attribute [r] line2 + # @!attribute line2 # The second line of the address. This might be the floor or room number. # # @return [String, nil] optional :line2, String - # @!parse - # # @return [String] - # attr_writer :line2 - - # @!parse - # # The entity's physical address. Mail receiving locations like PO Boxes and PMB's - # # are disallowed. - # # - # # @param city [String] - # # @param line1 [String] - # # @param state [String] - # # @param zip [String] - # # @param line2 [String] - # # - # def initialize(city:, line1:, state:, zip:, line2: nil, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(city:, line1:, state:, zip:, line2: nil) + # The entity's physical address. Mail receiving locations like PO Boxes and PMB's + # are disallowed. + # + # @param city [String] + # @param line1 [String] + # @param state [String] + # @param zip [String] + # @param line2 [String] end class AuthorizedPerson < Increase::Internal::Type::BaseModel @@ -828,12 +673,8 @@ class AuthorizedPerson < Increase::Internal::Type::BaseModel # @return [String] required :name, String - # @!parse - # # @param name [String] - # # - # def initialize(name:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(name:) + # @param name [String] end # The category of the government authority. @@ -845,11 +686,8 @@ module Category # The Public Entity is a Municipality. MUNICIPALITY = :municipality - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -861,26 +699,18 @@ class Joint < Increase::Internal::Type::BaseModel required :individuals, -> { Increase::Internal::Type::ArrayOf[Increase::Models::EntityCreateParams::Joint::Individual] } - # @!attribute [r] name + # @!attribute name # The name of the joint entity. # # @return [String, nil] optional :name, String - # @!parse - # # @return [String] - # attr_writer :name - - # @!parse - # # Details of the joint entity to create. Required if `structure` is equal to - # # `joint`. - # # - # # @param individuals [Array] - # # @param name [String] - # # - # def initialize(individuals:, name: nil, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(individuals:, name: nil) + # Details of the joint entity to create. Required if `structure` is equal to + # `joint`. + # + # @param individuals [Array] + # @param name [String] class Individual < Increase::Internal::Type::BaseModel # @!attribute address @@ -908,7 +738,7 @@ class Individual < Increase::Internal::Type::BaseModel # @return [String] required :name, String - # @!attribute [r] confirmed_no_us_tax_id + # @!attribute confirmed_no_us_tax_id # The identification method for an individual can only be a passport, driver's # license, or other document if you've confirmed the individual does not have a US # tax id (either a Social Security Number or Individual Taxpayer Identification @@ -917,20 +747,12 @@ class Individual < Increase::Internal::Type::BaseModel # @return [Boolean, nil] optional :confirmed_no_us_tax_id, Increase::Internal::Type::Boolean - # @!parse - # # @return [Boolean] - # attr_writer :confirmed_no_us_tax_id - - # @!parse - # # @param address [Increase::Models::EntityCreateParams::Joint::Individual::Address] - # # @param date_of_birth [Date] - # # @param identification [Increase::Models::EntityCreateParams::Joint::Individual::Identification] - # # @param name [String] - # # @param confirmed_no_us_tax_id [Boolean] - # # - # def initialize(address:, date_of_birth:, identification:, name:, confirmed_no_us_tax_id: nil, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(address:, date_of_birth:, identification:, name:, confirmed_no_us_tax_id: nil) + # @param address [Increase::Models::EntityCreateParams::Joint::Individual::Address] + # @param date_of_birth [Date] + # @param identification [Increase::Models::EntityCreateParams::Joint::Individual::Identification] + # @param name [String] + # @param confirmed_no_us_tax_id [Boolean] # @see Increase::Models::EntityCreateParams::Joint::Individual#address class Address < Increase::Internal::Type::BaseModel @@ -959,29 +781,21 @@ class Address < Increase::Internal::Type::BaseModel # @return [String] required :zip, String - # @!attribute [r] line2 + # @!attribute line2 # The second line of the address. This might be the floor or room number. # # @return [String, nil] optional :line2, String - # @!parse - # # @return [String] - # attr_writer :line2 - - # @!parse - # # The individual's physical address. Mail receiving locations like PO Boxes and - # # PMB's are disallowed. - # # - # # @param city [String] - # # @param line1 [String] - # # @param state [String] - # # @param zip [String] - # # @param line2 [String] - # # - # def initialize(city:, line1:, state:, zip:, line2: nil, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(city:, line1:, state:, zip:, line2: nil) + # The individual's physical address. Mail receiving locations like PO Boxes and + # PMB's are disallowed. + # + # @param city [String] + # @param line1 [String] + # @param state [String] + # @param zip [String] + # @param line2 [String] end # @see Increase::Models::EntityCreateParams::Joint::Individual#identification @@ -1001,7 +815,7 @@ class Identification < Increase::Internal::Type::BaseModel # @return [String] required :number, String - # @!attribute [r] drivers_license + # @!attribute drivers_license # Information about the United States driver's license used for identification. # Required if `method` is equal to `drivers_license`. # @@ -1009,22 +823,14 @@ class Identification < Increase::Internal::Type::BaseModel optional :drivers_license, -> { Increase::Models::EntityCreateParams::Joint::Individual::Identification::DriversLicense } - # @!parse - # # @return [Increase::Models::EntityCreateParams::Joint::Individual::Identification::DriversLicense] - # attr_writer :drivers_license - - # @!attribute [r] other + # @!attribute other # Information about the identification document provided. Required if `method` is # equal to `other`. # # @return [Increase::Models::EntityCreateParams::Joint::Individual::Identification::Other, nil] optional :other, -> { Increase::Models::EntityCreateParams::Joint::Individual::Identification::Other } - # @!parse - # # @return [Increase::Models::EntityCreateParams::Joint::Individual::Identification::Other] - # attr_writer :other - - # @!attribute [r] passport + # @!attribute passport # Information about the passport used for identification. Required if `method` is # equal to `passport`. # @@ -1032,22 +838,14 @@ class Identification < Increase::Internal::Type::BaseModel optional :passport, -> { Increase::Models::EntityCreateParams::Joint::Individual::Identification::Passport } - # @!parse - # # @return [Increase::Models::EntityCreateParams::Joint::Individual::Identification::Passport] - # attr_writer :passport - - # @!parse - # # A means of verifying the person's identity. - # # - # # @param method_ [Symbol, Increase::Models::EntityCreateParams::Joint::Individual::Identification::Method] - # # @param number [String] - # # @param drivers_license [Increase::Models::EntityCreateParams::Joint::Individual::Identification::DriversLicense] - # # @param other [Increase::Models::EntityCreateParams::Joint::Individual::Identification::Other] - # # @param passport [Increase::Models::EntityCreateParams::Joint::Individual::Identification::Passport] - # # - # def initialize(method_:, number:, drivers_license: nil, other: nil, passport: nil, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(method_:, number:, drivers_license: nil, other: nil, passport: nil) + # A means of verifying the person's identity. + # + # @param method_ [Symbol, Increase::Models::EntityCreateParams::Joint::Individual::Identification::Method] + # @param number [String] + # @param drivers_license [Increase::Models::EntityCreateParams::Joint::Individual::Identification::DriversLicense] + # @param other [Increase::Models::EntityCreateParams::Joint::Individual::Identification::Other] + # @param passport [Increase::Models::EntityCreateParams::Joint::Individual::Identification::Passport] # A method that can be used to verify the individual's identity. # @@ -1070,11 +868,8 @@ module Method # Another identifying document. OTHER = :other - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Increase::Models::EntityCreateParams::Joint::Individual::Identification#drivers_license @@ -1097,28 +892,20 @@ class DriversLicense < Increase::Internal::Type::BaseModel # @return [String] required :state, String - # @!attribute [r] back_file_id + # @!attribute back_file_id # The identifier of the File containing the back of the driver's license. # # @return [String, nil] optional :back_file_id, String - # @!parse - # # @return [String] - # attr_writer :back_file_id - - # @!parse - # # Information about the United States driver's license used for identification. - # # Required if `method` is equal to `drivers_license`. - # # - # # @param expiration_date [Date] - # # @param file_id [String] - # # @param state [String] - # # @param back_file_id [String] - # # - # def initialize(expiration_date:, file_id:, state:, back_file_id: nil, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(expiration_date:, file_id:, state:, back_file_id: nil) + # Information about the United States driver's license used for identification. + # Required if `method` is equal to `drivers_license`. + # + # @param expiration_date [Date] + # @param file_id [String] + # @param state [String] + # @param back_file_id [String] end # @see Increase::Models::EntityCreateParams::Joint::Individual::Identification#other @@ -1142,40 +929,28 @@ class Other < Increase::Internal::Type::BaseModel # @return [String] required :file_id, String - # @!attribute [r] back_file_id + # @!attribute back_file_id # The identifier of the File containing the back of the document. Not every # document has a reverse side. # # @return [String, nil] optional :back_file_id, String - # @!parse - # # @return [String] - # attr_writer :back_file_id - - # @!attribute [r] expiration_date + # @!attribute expiration_date # The document's expiration date in YYYY-MM-DD format. # # @return [Date, nil] optional :expiration_date, Date - # @!parse - # # @return [Date] - # attr_writer :expiration_date - - # @!parse - # # Information about the identification document provided. Required if `method` is - # # equal to `other`. - # # - # # @param country [String] - # # @param description [String] - # # @param file_id [String] - # # @param back_file_id [String] - # # @param expiration_date [Date] - # # - # def initialize(country:, description:, file_id:, back_file_id: nil, expiration_date: nil, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(country:, description:, file_id:, back_file_id: nil, expiration_date: nil) + # Information about the identification document provided. Required if `method` is + # equal to `other`. + # + # @param country [String] + # @param description [String] + # @param file_id [String] + # @param back_file_id [String] + # @param expiration_date [Date] end # @see Increase::Models::EntityCreateParams::Joint::Individual::Identification#passport @@ -1198,17 +973,13 @@ class Passport < Increase::Internal::Type::BaseModel # @return [String] required :file_id, String - # @!parse - # # Information about the passport used for identification. Required if `method` is - # # equal to `passport`. - # # - # # @param country [String] - # # @param expiration_date [Date] - # # @param file_id [String] - # # - # def initialize(country:, expiration_date:, file_id:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(country:, expiration_date:, file_id:) + # Information about the passport used for identification. Required if `method` is + # equal to `passport`. + # + # @param country [String] + # @param expiration_date [Date] + # @param file_id [String] end end end @@ -1240,7 +1011,7 @@ class NaturalPerson < Increase::Internal::Type::BaseModel # @return [String] required :name, String - # @!attribute [r] confirmed_no_us_tax_id + # @!attribute confirmed_no_us_tax_id # The identification method for an individual can only be a passport, driver's # license, or other document if you've confirmed the individual does not have a US # tax id (either a Social Security Number or Individual Taxpayer Identification @@ -1249,25 +1020,17 @@ class NaturalPerson < Increase::Internal::Type::BaseModel # @return [Boolean, nil] optional :confirmed_no_us_tax_id, Increase::Internal::Type::Boolean - # @!parse - # # @return [Boolean] - # attr_writer :confirmed_no_us_tax_id - - # @!parse - # # Details of the natural person entity to create. Required if `structure` is equal - # # to `natural_person`. Natural people entities should be submitted with - # # `social_security_number` or `individual_taxpayer_identification_number` - # # identification methods. - # # - # # @param address [Increase::Models::EntityCreateParams::NaturalPerson::Address] - # # @param date_of_birth [Date] - # # @param identification [Increase::Models::EntityCreateParams::NaturalPerson::Identification] - # # @param name [String] - # # @param confirmed_no_us_tax_id [Boolean] - # # - # def initialize(address:, date_of_birth:, identification:, name:, confirmed_no_us_tax_id: nil, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(address:, date_of_birth:, identification:, name:, confirmed_no_us_tax_id: nil) + # Details of the natural person entity to create. Required if `structure` is equal + # to `natural_person`. Natural people entities should be submitted with + # `social_security_number` or `individual_taxpayer_identification_number` + # identification methods. + # + # @param address [Increase::Models::EntityCreateParams::NaturalPerson::Address] + # @param date_of_birth [Date] + # @param identification [Increase::Models::EntityCreateParams::NaturalPerson::Identification] + # @param name [String] + # @param confirmed_no_us_tax_id [Boolean] # @see Increase::Models::EntityCreateParams::NaturalPerson#address class Address < Increase::Internal::Type::BaseModel @@ -1296,29 +1059,21 @@ class Address < Increase::Internal::Type::BaseModel # @return [String] required :zip, String - # @!attribute [r] line2 + # @!attribute line2 # The second line of the address. This might be the floor or room number. # # @return [String, nil] optional :line2, String - # @!parse - # # @return [String] - # attr_writer :line2 - - # @!parse - # # The individual's physical address. Mail receiving locations like PO Boxes and - # # PMB's are disallowed. - # # - # # @param city [String] - # # @param line1 [String] - # # @param state [String] - # # @param zip [String] - # # @param line2 [String] - # # - # def initialize(city:, line1:, state:, zip:, line2: nil, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(city:, line1:, state:, zip:, line2: nil) + # The individual's physical address. Mail receiving locations like PO Boxes and + # PMB's are disallowed. + # + # @param city [String] + # @param line1 [String] + # @param state [String] + # @param zip [String] + # @param line2 [String] end # @see Increase::Models::EntityCreateParams::NaturalPerson#identification @@ -1338,7 +1093,7 @@ class Identification < Increase::Internal::Type::BaseModel # @return [String] required :number, String - # @!attribute [r] drivers_license + # @!attribute drivers_license # Information about the United States driver's license used for identification. # Required if `method` is equal to `drivers_license`. # @@ -1346,44 +1101,28 @@ class Identification < Increase::Internal::Type::BaseModel optional :drivers_license, -> { Increase::Models::EntityCreateParams::NaturalPerson::Identification::DriversLicense } - # @!parse - # # @return [Increase::Models::EntityCreateParams::NaturalPerson::Identification::DriversLicense] - # attr_writer :drivers_license - - # @!attribute [r] other + # @!attribute other # Information about the identification document provided. Required if `method` is # equal to `other`. # # @return [Increase::Models::EntityCreateParams::NaturalPerson::Identification::Other, nil] optional :other, -> { Increase::Models::EntityCreateParams::NaturalPerson::Identification::Other } - # @!parse - # # @return [Increase::Models::EntityCreateParams::NaturalPerson::Identification::Other] - # attr_writer :other - - # @!attribute [r] passport + # @!attribute passport # Information about the passport used for identification. Required if `method` is # equal to `passport`. # # @return [Increase::Models::EntityCreateParams::NaturalPerson::Identification::Passport, nil] optional :passport, -> { Increase::Models::EntityCreateParams::NaturalPerson::Identification::Passport } - # @!parse - # # @return [Increase::Models::EntityCreateParams::NaturalPerson::Identification::Passport] - # attr_writer :passport - - # @!parse - # # A means of verifying the person's identity. - # # - # # @param method_ [Symbol, Increase::Models::EntityCreateParams::NaturalPerson::Identification::Method] - # # @param number [String] - # # @param drivers_license [Increase::Models::EntityCreateParams::NaturalPerson::Identification::DriversLicense] - # # @param other [Increase::Models::EntityCreateParams::NaturalPerson::Identification::Other] - # # @param passport [Increase::Models::EntityCreateParams::NaturalPerson::Identification::Passport] - # # - # def initialize(method_:, number:, drivers_license: nil, other: nil, passport: nil, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(method_:, number:, drivers_license: nil, other: nil, passport: nil) + # A means of verifying the person's identity. + # + # @param method_ [Symbol, Increase::Models::EntityCreateParams::NaturalPerson::Identification::Method] + # @param number [String] + # @param drivers_license [Increase::Models::EntityCreateParams::NaturalPerson::Identification::DriversLicense] + # @param other [Increase::Models::EntityCreateParams::NaturalPerson::Identification::Other] + # @param passport [Increase::Models::EntityCreateParams::NaturalPerson::Identification::Passport] # A method that can be used to verify the individual's identity. # @@ -1406,11 +1145,8 @@ module Method # Another identifying document. OTHER = :other - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Increase::Models::EntityCreateParams::NaturalPerson::Identification#drivers_license @@ -1433,28 +1169,20 @@ class DriversLicense < Increase::Internal::Type::BaseModel # @return [String] required :state, String - # @!attribute [r] back_file_id + # @!attribute back_file_id # The identifier of the File containing the back of the driver's license. # # @return [String, nil] optional :back_file_id, String - # @!parse - # # @return [String] - # attr_writer :back_file_id - - # @!parse - # # Information about the United States driver's license used for identification. - # # Required if `method` is equal to `drivers_license`. - # # - # # @param expiration_date [Date] - # # @param file_id [String] - # # @param state [String] - # # @param back_file_id [String] - # # - # def initialize(expiration_date:, file_id:, state:, back_file_id: nil, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(expiration_date:, file_id:, state:, back_file_id: nil) + # Information about the United States driver's license used for identification. + # Required if `method` is equal to `drivers_license`. + # + # @param expiration_date [Date] + # @param file_id [String] + # @param state [String] + # @param back_file_id [String] end # @see Increase::Models::EntityCreateParams::NaturalPerson::Identification#other @@ -1478,40 +1206,28 @@ class Other < Increase::Internal::Type::BaseModel # @return [String] required :file_id, String - # @!attribute [r] back_file_id + # @!attribute back_file_id # The identifier of the File containing the back of the document. Not every # document has a reverse side. # # @return [String, nil] optional :back_file_id, String - # @!parse - # # @return [String] - # attr_writer :back_file_id - - # @!attribute [r] expiration_date + # @!attribute expiration_date # The document's expiration date in YYYY-MM-DD format. # # @return [Date, nil] optional :expiration_date, Date - # @!parse - # # @return [Date] - # attr_writer :expiration_date - - # @!parse - # # Information about the identification document provided. Required if `method` is - # # equal to `other`. - # # - # # @param country [String] - # # @param description [String] - # # @param file_id [String] - # # @param back_file_id [String] - # # @param expiration_date [Date] - # # - # def initialize(country:, description:, file_id:, back_file_id: nil, expiration_date: nil, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(country:, description:, file_id:, back_file_id: nil, expiration_date: nil) + # Information about the identification document provided. Required if `method` is + # equal to `other`. + # + # @param country [String] + # @param description [String] + # @param file_id [String] + # @param back_file_id [String] + # @param expiration_date [Date] end # @see Increase::Models::EntityCreateParams::NaturalPerson::Identification#passport @@ -1534,17 +1250,13 @@ class Passport < Increase::Internal::Type::BaseModel # @return [String] required :file_id, String - # @!parse - # # Information about the passport used for identification. Required if `method` is - # # equal to `passport`. - # # - # # @param country [String] - # # @param expiration_date [Date] - # # @param file_id [String] - # # - # def initialize(country:, expiration_date:, file_id:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(country:, expiration_date:, file_id:) + # Information about the passport used for identification. Required if `method` is + # equal to `passport`. + # + # @param country [String] + # @param expiration_date [Date] + # @param file_id [String] end end end @@ -1556,12 +1268,8 @@ class SupplementalDocument < Increase::Internal::Type::BaseModel # @return [String] required :file_id, String - # @!parse - # # @param file_id [String] - # # - # def initialize(file_id:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(file_id:) + # @param file_id [String] end class ThirdPartyVerification < Increase::Internal::Type::BaseModel @@ -1577,16 +1285,12 @@ class ThirdPartyVerification < Increase::Internal::Type::BaseModel # @return [Symbol, Increase::Models::EntityCreateParams::ThirdPartyVerification::Vendor] required :vendor, enum: -> { Increase::Models::EntityCreateParams::ThirdPartyVerification::Vendor } - # @!parse - # # A reference to data stored in a third-party verification service. Your - # # integration may or may not use this field. - # # - # # @param reference [String] - # # @param vendor [Symbol, Increase::Models::EntityCreateParams::ThirdPartyVerification::Vendor] - # # - # def initialize(reference:, vendor:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(reference:, vendor:) + # A reference to data stored in a third-party verification service. Your + # integration may or may not use this field. + # + # @param reference [String] + # @param vendor [Symbol, Increase::Models::EntityCreateParams::ThirdPartyVerification::Vendor] # The vendor that was used to perform the verification. # @@ -1600,11 +1304,8 @@ module Vendor # Middesk. See https://middesk.com for more information. MIDDESK = :middesk - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -1637,76 +1338,44 @@ class Trust < Increase::Internal::Type::BaseModel required :trustees, -> { Increase::Internal::Type::ArrayOf[Increase::Models::EntityCreateParams::Trust::Trustee] } - # @!attribute [r] formation_document_file_id + # @!attribute formation_document_file_id # The identifier of the File containing the formation document of the trust. # # @return [String, nil] optional :formation_document_file_id, String - # @!parse - # # @return [String] - # attr_writer :formation_document_file_id - - # @!attribute [r] formation_state + # @!attribute formation_state # The two-letter United States Postal Service (USPS) abbreviation for the state in # which the trust was formed. # # @return [String, nil] optional :formation_state, String - # @!parse - # # @return [String] - # attr_writer :formation_state - - # @!attribute [r] grantor + # @!attribute grantor # The grantor of the trust. Required if `category` is equal to `revocable`. # # @return [Increase::Models::EntityCreateParams::Trust::Grantor, nil] optional :grantor, -> { Increase::Models::EntityCreateParams::Trust::Grantor } - # @!parse - # # @return [Increase::Models::EntityCreateParams::Trust::Grantor] - # attr_writer :grantor - - # @!attribute [r] tax_identifier + # @!attribute tax_identifier # The Employer Identification Number (EIN) for the trust. Required if `category` # is equal to `irrevocable`. # # @return [String, nil] optional :tax_identifier, String - # @!parse - # # @return [String] - # attr_writer :tax_identifier - - # @!parse - # # Details of the trust entity to create. Required if `structure` is equal to - # # `trust`. - # # - # # @param address [Increase::Models::EntityCreateParams::Trust::Address] - # # @param category [Symbol, Increase::Models::EntityCreateParams::Trust::Category] - # # @param name [String] - # # @param trustees [Array] - # # @param formation_document_file_id [String] - # # @param formation_state [String] - # # @param grantor [Increase::Models::EntityCreateParams::Trust::Grantor] - # # @param tax_identifier [String] - # # - # def initialize( - # address:, - # category:, - # name:, - # trustees:, - # formation_document_file_id: nil, - # formation_state: nil, - # grantor: nil, - # tax_identifier: nil, - # ** - # ) - # super - # end - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(address:, category:, name:, trustees:, formation_document_file_id: nil, formation_state: nil, grantor: nil, tax_identifier: nil) + # Details of the trust entity to create. Required if `structure` is equal to + # `trust`. + # + # @param address [Increase::Models::EntityCreateParams::Trust::Address] + # @param category [Symbol, Increase::Models::EntityCreateParams::Trust::Category] + # @param name [String] + # @param trustees [Array] + # @param formation_document_file_id [String] + # @param formation_state [String] + # @param grantor [Increase::Models::EntityCreateParams::Trust::Grantor] + # @param tax_identifier [String] # @see Increase::Models::EntityCreateParams::Trust#address class Address < Increase::Internal::Type::BaseModel @@ -1735,29 +1404,21 @@ class Address < Increase::Internal::Type::BaseModel # @return [String] required :zip, String - # @!attribute [r] line2 + # @!attribute line2 # The second line of the address. This might be the floor or room number. # # @return [String, nil] optional :line2, String - # @!parse - # # @return [String] - # attr_writer :line2 - - # @!parse - # # The trust's physical address. Mail receiving locations like PO Boxes and PMB's - # # are disallowed. - # # - # # @param city [String] - # # @param line1 [String] - # # @param state [String] - # # @param zip [String] - # # @param line2 [String] - # # - # def initialize(city:, line1:, state:, zip:, line2: nil, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(city:, line1:, state:, zip:, line2: nil) + # The trust's physical address. Mail receiving locations like PO Boxes and PMB's + # are disallowed. + # + # @param city [String] + # @param line1 [String] + # @param state [String] + # @param zip [String] + # @param line2 [String] end # Whether the trust is `revocable` or `irrevocable`. Irrevocable trusts require @@ -1774,11 +1435,8 @@ module Category # The trust cannot be revoked. IRREVOCABLE = :irrevocable - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end class Trustee < Increase::Internal::Type::BaseModel @@ -1788,24 +1446,16 @@ class Trustee < Increase::Internal::Type::BaseModel # @return [Symbol, Increase::Models::EntityCreateParams::Trust::Trustee::Structure] required :structure, enum: -> { Increase::Models::EntityCreateParams::Trust::Trustee::Structure } - # @!attribute [r] individual + # @!attribute individual # Details of the individual trustee. Required when the trustee `structure` is # equal to `individual`. # # @return [Increase::Models::EntityCreateParams::Trust::Trustee::Individual, nil] optional :individual, -> { Increase::Models::EntityCreateParams::Trust::Trustee::Individual } - # @!parse - # # @return [Increase::Models::EntityCreateParams::Trust::Trustee::Individual] - # attr_writer :individual - - # @!parse - # # @param structure [Symbol, Increase::Models::EntityCreateParams::Trust::Trustee::Structure] - # # @param individual [Increase::Models::EntityCreateParams::Trust::Trustee::Individual] - # # - # def initialize(structure:, individual: nil, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(structure:, individual: nil) + # @param structure [Symbol, Increase::Models::EntityCreateParams::Trust::Trustee::Structure] + # @param individual [Increase::Models::EntityCreateParams::Trust::Trustee::Individual] # The structure of the trustee. # @@ -1816,11 +1466,8 @@ module Structure # The trustee is an individual. INDIVIDUAL = :individual - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Increase::Models::EntityCreateParams::Trust::Trustee#individual @@ -1851,7 +1498,7 @@ class Individual < Increase::Internal::Type::BaseModel # @return [String] required :name, String - # @!attribute [r] confirmed_no_us_tax_id + # @!attribute confirmed_no_us_tax_id # The identification method for an individual can only be a passport, driver's # license, or other document if you've confirmed the individual does not have a US # tax id (either a Social Security Number or Individual Taxpayer Identification @@ -1860,23 +1507,15 @@ class Individual < Increase::Internal::Type::BaseModel # @return [Boolean, nil] optional :confirmed_no_us_tax_id, Increase::Internal::Type::Boolean - # @!parse - # # @return [Boolean] - # attr_writer :confirmed_no_us_tax_id - - # @!parse - # # Details of the individual trustee. Required when the trustee `structure` is - # # equal to `individual`. - # # - # # @param address [Increase::Models::EntityCreateParams::Trust::Trustee::Individual::Address] - # # @param date_of_birth [Date] - # # @param identification [Increase::Models::EntityCreateParams::Trust::Trustee::Individual::Identification] - # # @param name [String] - # # @param confirmed_no_us_tax_id [Boolean] - # # - # def initialize(address:, date_of_birth:, identification:, name:, confirmed_no_us_tax_id: nil, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(address:, date_of_birth:, identification:, name:, confirmed_no_us_tax_id: nil) + # Details of the individual trustee. Required when the trustee `structure` is + # equal to `individual`. + # + # @param address [Increase::Models::EntityCreateParams::Trust::Trustee::Individual::Address] + # @param date_of_birth [Date] + # @param identification [Increase::Models::EntityCreateParams::Trust::Trustee::Individual::Identification] + # @param name [String] + # @param confirmed_no_us_tax_id [Boolean] # @see Increase::Models::EntityCreateParams::Trust::Trustee::Individual#address class Address < Increase::Internal::Type::BaseModel @@ -1905,29 +1544,21 @@ class Address < Increase::Internal::Type::BaseModel # @return [String] required :zip, String - # @!attribute [r] line2 + # @!attribute line2 # The second line of the address. This might be the floor or room number. # # @return [String, nil] optional :line2, String - # @!parse - # # @return [String] - # attr_writer :line2 - - # @!parse - # # The individual's physical address. Mail receiving locations like PO Boxes and - # # PMB's are disallowed. - # # - # # @param city [String] - # # @param line1 [String] - # # @param state [String] - # # @param zip [String] - # # @param line2 [String] - # # - # def initialize(city:, line1:, state:, zip:, line2: nil, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(city:, line1:, state:, zip:, line2: nil) + # The individual's physical address. Mail receiving locations like PO Boxes and + # PMB's are disallowed. + # + # @param city [String] + # @param line1 [String] + # @param state [String] + # @param zip [String] + # @param line2 [String] end # @see Increase::Models::EntityCreateParams::Trust::Trustee::Individual#identification @@ -1947,7 +1578,7 @@ class Identification < Increase::Internal::Type::BaseModel # @return [String] required :number, String - # @!attribute [r] drivers_license + # @!attribute drivers_license # Information about the United States driver's license used for identification. # Required if `method` is equal to `drivers_license`. # @@ -1955,11 +1586,7 @@ class Identification < Increase::Internal::Type::BaseModel optional :drivers_license, -> { Increase::Models::EntityCreateParams::Trust::Trustee::Individual::Identification::DriversLicense } - # @!parse - # # @return [Increase::Models::EntityCreateParams::Trust::Trustee::Individual::Identification::DriversLicense] - # attr_writer :drivers_license - - # @!attribute [r] other + # @!attribute other # Information about the identification document provided. Required if `method` is # equal to `other`. # @@ -1967,11 +1594,7 @@ class Identification < Increase::Internal::Type::BaseModel optional :other, -> { Increase::Models::EntityCreateParams::Trust::Trustee::Individual::Identification::Other } - # @!parse - # # @return [Increase::Models::EntityCreateParams::Trust::Trustee::Individual::Identification::Other] - # attr_writer :other - - # @!attribute [r] passport + # @!attribute passport # Information about the passport used for identification. Required if `method` is # equal to `passport`. # @@ -1979,22 +1602,14 @@ class Identification < Increase::Internal::Type::BaseModel optional :passport, -> { Increase::Models::EntityCreateParams::Trust::Trustee::Individual::Identification::Passport } - # @!parse - # # @return [Increase::Models::EntityCreateParams::Trust::Trustee::Individual::Identification::Passport] - # attr_writer :passport - - # @!parse - # # A means of verifying the person's identity. - # # - # # @param method_ [Symbol, Increase::Models::EntityCreateParams::Trust::Trustee::Individual::Identification::Method] - # # @param number [String] - # # @param drivers_license [Increase::Models::EntityCreateParams::Trust::Trustee::Individual::Identification::DriversLicense] - # # @param other [Increase::Models::EntityCreateParams::Trust::Trustee::Individual::Identification::Other] - # # @param passport [Increase::Models::EntityCreateParams::Trust::Trustee::Individual::Identification::Passport] - # # - # def initialize(method_:, number:, drivers_license: nil, other: nil, passport: nil, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(method_:, number:, drivers_license: nil, other: nil, passport: nil) + # A means of verifying the person's identity. + # + # @param method_ [Symbol, Increase::Models::EntityCreateParams::Trust::Trustee::Individual::Identification::Method] + # @param number [String] + # @param drivers_license [Increase::Models::EntityCreateParams::Trust::Trustee::Individual::Identification::DriversLicense] + # @param other [Increase::Models::EntityCreateParams::Trust::Trustee::Individual::Identification::Other] + # @param passport [Increase::Models::EntityCreateParams::Trust::Trustee::Individual::Identification::Passport] # A method that can be used to verify the individual's identity. # @@ -2017,11 +1632,8 @@ module Method # Another identifying document. OTHER = :other - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Increase::Models::EntityCreateParams::Trust::Trustee::Individual::Identification#drivers_license @@ -2044,28 +1656,20 @@ class DriversLicense < Increase::Internal::Type::BaseModel # @return [String] required :state, String - # @!attribute [r] back_file_id + # @!attribute back_file_id # The identifier of the File containing the back of the driver's license. # # @return [String, nil] optional :back_file_id, String - # @!parse - # # @return [String] - # attr_writer :back_file_id - - # @!parse - # # Information about the United States driver's license used for identification. - # # Required if `method` is equal to `drivers_license`. - # # - # # @param expiration_date [Date] - # # @param file_id [String] - # # @param state [String] - # # @param back_file_id [String] - # # - # def initialize(expiration_date:, file_id:, state:, back_file_id: nil, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(expiration_date:, file_id:, state:, back_file_id: nil) + # Information about the United States driver's license used for identification. + # Required if `method` is equal to `drivers_license`. + # + # @param expiration_date [Date] + # @param file_id [String] + # @param state [String] + # @param back_file_id [String] end # @see Increase::Models::EntityCreateParams::Trust::Trustee::Individual::Identification#other @@ -2089,40 +1693,28 @@ class Other < Increase::Internal::Type::BaseModel # @return [String] required :file_id, String - # @!attribute [r] back_file_id + # @!attribute back_file_id # The identifier of the File containing the back of the document. Not every # document has a reverse side. # # @return [String, nil] optional :back_file_id, String - # @!parse - # # @return [String] - # attr_writer :back_file_id - - # @!attribute [r] expiration_date + # @!attribute expiration_date # The document's expiration date in YYYY-MM-DD format. # # @return [Date, nil] optional :expiration_date, Date - # @!parse - # # @return [Date] - # attr_writer :expiration_date - - # @!parse - # # Information about the identification document provided. Required if `method` is - # # equal to `other`. - # # - # # @param country [String] - # # @param description [String] - # # @param file_id [String] - # # @param back_file_id [String] - # # @param expiration_date [Date] - # # - # def initialize(country:, description:, file_id:, back_file_id: nil, expiration_date: nil, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(country:, description:, file_id:, back_file_id: nil, expiration_date: nil) + # Information about the identification document provided. Required if `method` is + # equal to `other`. + # + # @param country [String] + # @param description [String] + # @param file_id [String] + # @param back_file_id [String] + # @param expiration_date [Date] end # @see Increase::Models::EntityCreateParams::Trust::Trustee::Individual::Identification#passport @@ -2145,17 +1737,13 @@ class Passport < Increase::Internal::Type::BaseModel # @return [String] required :file_id, String - # @!parse - # # Information about the passport used for identification. Required if `method` is - # # equal to `passport`. - # # - # # @param country [String] - # # @param expiration_date [Date] - # # @param file_id [String] - # # - # def initialize(country:, expiration_date:, file_id:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(country:, expiration_date:, file_id:) + # Information about the passport used for identification. Required if `method` is + # equal to `passport`. + # + # @param country [String] + # @param expiration_date [Date] + # @param file_id [String] end end end @@ -2188,7 +1776,7 @@ class Grantor < Increase::Internal::Type::BaseModel # @return [String] required :name, String - # @!attribute [r] confirmed_no_us_tax_id + # @!attribute confirmed_no_us_tax_id # The identification method for an individual can only be a passport, driver's # license, or other document if you've confirmed the individual does not have a US # tax id (either a Social Security Number or Individual Taxpayer Identification @@ -2197,22 +1785,14 @@ class Grantor < Increase::Internal::Type::BaseModel # @return [Boolean, nil] optional :confirmed_no_us_tax_id, Increase::Internal::Type::Boolean - # @!parse - # # @return [Boolean] - # attr_writer :confirmed_no_us_tax_id - - # @!parse - # # The grantor of the trust. Required if `category` is equal to `revocable`. - # # - # # @param address [Increase::Models::EntityCreateParams::Trust::Grantor::Address] - # # @param date_of_birth [Date] - # # @param identification [Increase::Models::EntityCreateParams::Trust::Grantor::Identification] - # # @param name [String] - # # @param confirmed_no_us_tax_id [Boolean] - # # - # def initialize(address:, date_of_birth:, identification:, name:, confirmed_no_us_tax_id: nil, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(address:, date_of_birth:, identification:, name:, confirmed_no_us_tax_id: nil) + # The grantor of the trust. Required if `category` is equal to `revocable`. + # + # @param address [Increase::Models::EntityCreateParams::Trust::Grantor::Address] + # @param date_of_birth [Date] + # @param identification [Increase::Models::EntityCreateParams::Trust::Grantor::Identification] + # @param name [String] + # @param confirmed_no_us_tax_id [Boolean] # @see Increase::Models::EntityCreateParams::Trust::Grantor#address class Address < Increase::Internal::Type::BaseModel @@ -2241,29 +1821,21 @@ class Address < Increase::Internal::Type::BaseModel # @return [String] required :zip, String - # @!attribute [r] line2 + # @!attribute line2 # The second line of the address. This might be the floor or room number. # # @return [String, nil] optional :line2, String - # @!parse - # # @return [String] - # attr_writer :line2 - - # @!parse - # # The individual's physical address. Mail receiving locations like PO Boxes and - # # PMB's are disallowed. - # # - # # @param city [String] - # # @param line1 [String] - # # @param state [String] - # # @param zip [String] - # # @param line2 [String] - # # - # def initialize(city:, line1:, state:, zip:, line2: nil, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(city:, line1:, state:, zip:, line2: nil) + # The individual's physical address. Mail receiving locations like PO Boxes and + # PMB's are disallowed. + # + # @param city [String] + # @param line1 [String] + # @param state [String] + # @param zip [String] + # @param line2 [String] end # @see Increase::Models::EntityCreateParams::Trust::Grantor#identification @@ -2283,7 +1855,7 @@ class Identification < Increase::Internal::Type::BaseModel # @return [String] required :number, String - # @!attribute [r] drivers_license + # @!attribute drivers_license # Information about the United States driver's license used for identification. # Required if `method` is equal to `drivers_license`. # @@ -2291,44 +1863,28 @@ class Identification < Increase::Internal::Type::BaseModel optional :drivers_license, -> { Increase::Models::EntityCreateParams::Trust::Grantor::Identification::DriversLicense } - # @!parse - # # @return [Increase::Models::EntityCreateParams::Trust::Grantor::Identification::DriversLicense] - # attr_writer :drivers_license - - # @!attribute [r] other + # @!attribute other # Information about the identification document provided. Required if `method` is # equal to `other`. # # @return [Increase::Models::EntityCreateParams::Trust::Grantor::Identification::Other, nil] optional :other, -> { Increase::Models::EntityCreateParams::Trust::Grantor::Identification::Other } - # @!parse - # # @return [Increase::Models::EntityCreateParams::Trust::Grantor::Identification::Other] - # attr_writer :other - - # @!attribute [r] passport + # @!attribute passport # Information about the passport used for identification. Required if `method` is # equal to `passport`. # # @return [Increase::Models::EntityCreateParams::Trust::Grantor::Identification::Passport, nil] optional :passport, -> { Increase::Models::EntityCreateParams::Trust::Grantor::Identification::Passport } - # @!parse - # # @return [Increase::Models::EntityCreateParams::Trust::Grantor::Identification::Passport] - # attr_writer :passport - - # @!parse - # # A means of verifying the person's identity. - # # - # # @param method_ [Symbol, Increase::Models::EntityCreateParams::Trust::Grantor::Identification::Method] - # # @param number [String] - # # @param drivers_license [Increase::Models::EntityCreateParams::Trust::Grantor::Identification::DriversLicense] - # # @param other [Increase::Models::EntityCreateParams::Trust::Grantor::Identification::Other] - # # @param passport [Increase::Models::EntityCreateParams::Trust::Grantor::Identification::Passport] - # # - # def initialize(method_:, number:, drivers_license: nil, other: nil, passport: nil, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(method_:, number:, drivers_license: nil, other: nil, passport: nil) + # A means of verifying the person's identity. + # + # @param method_ [Symbol, Increase::Models::EntityCreateParams::Trust::Grantor::Identification::Method] + # @param number [String] + # @param drivers_license [Increase::Models::EntityCreateParams::Trust::Grantor::Identification::DriversLicense] + # @param other [Increase::Models::EntityCreateParams::Trust::Grantor::Identification::Other] + # @param passport [Increase::Models::EntityCreateParams::Trust::Grantor::Identification::Passport] # A method that can be used to verify the individual's identity. # @@ -2351,11 +1907,8 @@ module Method # Another identifying document. OTHER = :other - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Increase::Models::EntityCreateParams::Trust::Grantor::Identification#drivers_license @@ -2378,28 +1931,20 @@ class DriversLicense < Increase::Internal::Type::BaseModel # @return [String] required :state, String - # @!attribute [r] back_file_id + # @!attribute back_file_id # The identifier of the File containing the back of the driver's license. # # @return [String, nil] optional :back_file_id, String - # @!parse - # # @return [String] - # attr_writer :back_file_id - - # @!parse - # # Information about the United States driver's license used for identification. - # # Required if `method` is equal to `drivers_license`. - # # - # # @param expiration_date [Date] - # # @param file_id [String] - # # @param state [String] - # # @param back_file_id [String] - # # - # def initialize(expiration_date:, file_id:, state:, back_file_id: nil, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(expiration_date:, file_id:, state:, back_file_id: nil) + # Information about the United States driver's license used for identification. + # Required if `method` is equal to `drivers_license`. + # + # @param expiration_date [Date] + # @param file_id [String] + # @param state [String] + # @param back_file_id [String] end # @see Increase::Models::EntityCreateParams::Trust::Grantor::Identification#other @@ -2423,40 +1968,28 @@ class Other < Increase::Internal::Type::BaseModel # @return [String] required :file_id, String - # @!attribute [r] back_file_id + # @!attribute back_file_id # The identifier of the File containing the back of the document. Not every # document has a reverse side. # # @return [String, nil] optional :back_file_id, String - # @!parse - # # @return [String] - # attr_writer :back_file_id - - # @!attribute [r] expiration_date + # @!attribute expiration_date # The document's expiration date in YYYY-MM-DD format. # # @return [Date, nil] optional :expiration_date, Date - # @!parse - # # @return [Date] - # attr_writer :expiration_date - - # @!parse - # # Information about the identification document provided. Required if `method` is - # # equal to `other`. - # # - # # @param country [String] - # # @param description [String] - # # @param file_id [String] - # # @param back_file_id [String] - # # @param expiration_date [Date] - # # - # def initialize(country:, description:, file_id:, back_file_id: nil, expiration_date: nil, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(country:, description:, file_id:, back_file_id: nil, expiration_date: nil) + # Information about the identification document provided. Required if `method` is + # equal to `other`. + # + # @param country [String] + # @param description [String] + # @param file_id [String] + # @param back_file_id [String] + # @param expiration_date [Date] end # @see Increase::Models::EntityCreateParams::Trust::Grantor::Identification#passport @@ -2479,17 +2012,13 @@ class Passport < Increase::Internal::Type::BaseModel # @return [String] required :file_id, String - # @!parse - # # Information about the passport used for identification. Required if `method` is - # # equal to `passport`. - # # - # # @param country [String] - # # @param expiration_date [Date] - # # @param file_id [String] - # # - # def initialize(country:, expiration_date:, file_id:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(country:, expiration_date:, file_id:) + # Information about the passport used for identification. Required if `method` is + # equal to `passport`. + # + # @param country [String] + # @param expiration_date [Date] + # @param file_id [String] end end end diff --git a/lib/increase/models/entity_list_params.rb b/lib/increase/models/entity_list_params.rb index c7d273134..71ee9480b 100644 --- a/lib/increase/models/entity_list_params.rb +++ b/lib/increase/models/entity_list_params.rb @@ -4,30 +4,21 @@ module Increase module Models # @see Increase::Resources::Entities#list class EntityListParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters - # @!attribute [r] created_at + # @!attribute created_at # # @return [Increase::Models::EntityListParams::CreatedAt, nil] optional :created_at, -> { Increase::Models::EntityListParams::CreatedAt } - # @!parse - # # @return [Increase::Models::EntityListParams::CreatedAt] - # attr_writer :created_at - - # @!attribute [r] cursor + # @!attribute cursor # Return the page of entries after this one. # # @return [String, nil] optional :cursor, String - # @!parse - # # @return [String] - # attr_writer :cursor - - # @!attribute [r] idempotency_key + # @!attribute idempotency_key # Filter records to the one with the specified `idempotency_key` you chose for # that object. This value is unique across Increase and is used to ensure that a # request is only processed once. Learn more about @@ -36,100 +27,64 @@ class EntityListParams < Increase::Internal::Type::BaseModel # @return [String, nil] optional :idempotency_key, String - # @!parse - # # @return [String] - # attr_writer :idempotency_key - - # @!attribute [r] limit + # @!attribute limit # Limit the size of the list that is returned. The default (and maximum) is 100 # objects. # # @return [Integer, nil] optional :limit, Integer - # @!parse - # # @return [Integer] - # attr_writer :limit - - # @!attribute [r] status + # @!attribute status # # @return [Increase::Models::EntityListParams::Status, nil] optional :status, -> { Increase::Models::EntityListParams::Status } - # @!parse - # # @return [Increase::Models::EntityListParams::Status] - # attr_writer :status - - # @!parse - # # @param created_at [Increase::Models::EntityListParams::CreatedAt] - # # @param cursor [String] - # # @param idempotency_key [String] - # # @param limit [Integer] - # # @param status [Increase::Models::EntityListParams::Status] - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(created_at: nil, cursor: nil, idempotency_key: nil, limit: nil, status: nil, request_options: {}, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(created_at: nil, cursor: nil, idempotency_key: nil, limit: nil, status: nil, request_options: {}) + # @param created_at [Increase::Models::EntityListParams::CreatedAt] + # @param cursor [String] + # @param idempotency_key [String] + # @param limit [Integer] + # @param status [Increase::Models::EntityListParams::Status] + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] class CreatedAt < Increase::Internal::Type::BaseModel - # @!attribute [r] after + # @!attribute after # Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) # timestamp. # # @return [Time, nil] optional :after, Time - # @!parse - # # @return [Time] - # attr_writer :after - - # @!attribute [r] before + # @!attribute before # Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) # timestamp. # # @return [Time, nil] optional :before, Time - # @!parse - # # @return [Time] - # attr_writer :before - - # @!attribute [r] on_or_after + # @!attribute on_or_after # Return results on or after this # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. # # @return [Time, nil] optional :on_or_after, Time - # @!parse - # # @return [Time] - # attr_writer :on_or_after - - # @!attribute [r] on_or_before + # @!attribute on_or_before # Return results on or before this # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. # # @return [Time, nil] optional :on_or_before, Time - # @!parse - # # @return [Time] - # attr_writer :on_or_before - - # @!parse - # # @param after [Time] - # # @param before [Time] - # # @param on_or_after [Time] - # # @param on_or_before [Time] - # # - # def initialize(after: nil, before: nil, on_or_after: nil, on_or_before: nil, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(after: nil, before: nil, on_or_after: nil, on_or_before: nil) + # @param after [Time] + # @param before [Time] + # @param on_or_after [Time] + # @param on_or_before [Time] end class Status < Increase::Internal::Type::BaseModel - # @!attribute [r] in_ + # @!attribute in_ # Filter Entities for those with the specified status or statuses. For GET # requests, this should be encoded as a comma-delimited string, such as # `?in=one,two,three`. @@ -139,16 +94,8 @@ class Status < Increase::Internal::Type::BaseModel -> { Increase::Internal::Type::ArrayOf[enum: Increase::Models::EntityListParams::Status::In] }, api_name: :in - # @!parse - # # @return [Array] - # attr_writer :in_ - - # @!parse - # # @param in_ [Array] - # # - # def initialize(in_: nil, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(in_: nil) + # @param in_ [Array] module In extend Increase::Internal::Type::Enum @@ -162,11 +109,8 @@ module In # The entity is temporarily disabled and cannot be used for financial activity. DISABLED = :disabled - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end diff --git a/lib/increase/models/entity_retrieve_params.rb b/lib/increase/models/entity_retrieve_params.rb index 65c8cd7e1..b8b53614d 100644 --- a/lib/increase/models/entity_retrieve_params.rb +++ b/lib/increase/models/entity_retrieve_params.rb @@ -4,16 +4,11 @@ module Increase module Models # @see Increase::Resources::Entities#retrieve class EntityRetrieveParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters - # @!parse - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(request_options: {}, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(request_options: {}) + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/increase/models/entity_supplemental_document.rb b/lib/increase/models/entity_supplemental_document.rb index 354ffacda..4e9e6b177 100644 --- a/lib/increase/models/entity_supplemental_document.rb +++ b/lib/increase/models/entity_supplemental_document.rb @@ -38,19 +38,15 @@ class EntitySupplementalDocument < Increase::Internal::Type::BaseModel # @return [Symbol, Increase::Models::EntitySupplementalDocument::Type] required :type, enum: -> { Increase::Models::EntitySupplementalDocument::Type } - # @!parse - # # Supplemental Documents are uploaded files connected to an Entity during - # # onboarding. - # # - # # @param created_at [Time] - # # @param entity_id [String] - # # @param file_id [String] - # # @param idempotency_key [String, nil] - # # @param type [Symbol, Increase::Models::EntitySupplementalDocument::Type] - # # - # def initialize(created_at:, entity_id:, file_id:, idempotency_key:, type:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(created_at:, entity_id:, file_id:, idempotency_key:, type:) + # Supplemental Documents are uploaded files connected to an Entity during + # onboarding. + # + # @param created_at [Time] + # @param entity_id [String] + # @param file_id [String] + # @param idempotency_key [String, nil] + # @param type [Symbol, Increase::Models::EntitySupplementalDocument::Type] # A constant representing the object's type. For this resource it will always be # `entity_supplemental_document`. @@ -61,11 +57,8 @@ module Type ENTITY_SUPPLEMENTAL_DOCUMENT = :entity_supplemental_document - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end diff --git a/lib/increase/models/entity_update_address_params.rb b/lib/increase/models/entity_update_address_params.rb index 584201540..da9553eea 100644 --- a/lib/increase/models/entity_update_address_params.rb +++ b/lib/increase/models/entity_update_address_params.rb @@ -4,8 +4,7 @@ module Increase module Models # @see Increase::Resources::Entities#update_address class EntityUpdateAddressParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters # @!attribute address @@ -15,13 +14,9 @@ class EntityUpdateAddressParams < Increase::Internal::Type::BaseModel # @return [Increase::Models::EntityUpdateAddressParams::Address] required :address, -> { Increase::Models::EntityUpdateAddressParams::Address } - # @!parse - # # @param address [Increase::Models::EntityUpdateAddressParams::Address] - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(address:, request_options: {}, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(address:, request_options: {}) + # @param address [Increase::Models::EntityUpdateAddressParams::Address] + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] class Address < Increase::Internal::Type::BaseModel # @!attribute city @@ -49,29 +44,21 @@ class Address < Increase::Internal::Type::BaseModel # @return [String] required :zip, String - # @!attribute [r] line2 + # @!attribute line2 # The second line of the address. This might be the floor or room number. # # @return [String, nil] optional :line2, String - # @!parse - # # @return [String] - # attr_writer :line2 - - # @!parse - # # The entity's physical address. Mail receiving locations like PO Boxes and PMB's - # # are disallowed. - # # - # # @param city [String] - # # @param line1 [String] - # # @param state [String] - # # @param zip [String] - # # @param line2 [String] - # # - # def initialize(city:, line1:, state:, zip:, line2: nil, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(city:, line1:, state:, zip:, line2: nil) + # The entity's physical address. Mail receiving locations like PO Boxes and PMB's + # are disallowed. + # + # @param city [String] + # @param line1 [String] + # @param state [String] + # @param zip [String] + # @param line2 [String] end end end diff --git a/lib/increase/models/entity_update_beneficial_owner_address_params.rb b/lib/increase/models/entity_update_beneficial_owner_address_params.rb index d88583427..8409500f3 100644 --- a/lib/increase/models/entity_update_beneficial_owner_address_params.rb +++ b/lib/increase/models/entity_update_beneficial_owner_address_params.rb @@ -4,8 +4,7 @@ module Increase module Models # @see Increase::Resources::Entities#update_beneficial_owner_address class EntityUpdateBeneficialOwnerAddressParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters # @!attribute address @@ -22,14 +21,10 @@ class EntityUpdateBeneficialOwnerAddressParams < Increase::Internal::Type::BaseM # @return [String] required :beneficial_owner_id, String - # @!parse - # # @param address [Increase::Models::EntityUpdateBeneficialOwnerAddressParams::Address] - # # @param beneficial_owner_id [String] - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(address:, beneficial_owner_id:, request_options: {}, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(address:, beneficial_owner_id:, request_options: {}) + # @param address [Increase::Models::EntityUpdateBeneficialOwnerAddressParams::Address] + # @param beneficial_owner_id [String] + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] class Address < Increase::Internal::Type::BaseModel # @!attribute country @@ -44,62 +39,42 @@ class Address < Increase::Internal::Type::BaseModel # @return [String] required :line1, String - # @!attribute [r] city + # @!attribute city # The city, district, town, or village of the address. Required in certain # countries. # # @return [String, nil] optional :city, String - # @!parse - # # @return [String] - # attr_writer :city - - # @!attribute [r] line2 + # @!attribute line2 # The second line of the address. This might be the floor or room number. # # @return [String, nil] optional :line2, String - # @!parse - # # @return [String] - # attr_writer :line2 - - # @!attribute [r] state + # @!attribute state # The two-letter United States Postal Service (USPS) abbreviation for the US # state, province, or region of the address. Required in certain countries. # # @return [String, nil] optional :state, String - # @!parse - # # @return [String] - # attr_writer :state - - # @!attribute [r] zip + # @!attribute zip # The ZIP or postal code of the address. Required in certain countries. # # @return [String, nil] optional :zip, String - # @!parse - # # @return [String] - # attr_writer :zip - - # @!parse - # # The individual's physical address. Mail receiving locations like PO Boxes and - # # PMB's are disallowed. - # # - # # @param country [String] - # # @param line1 [String] - # # @param city [String] - # # @param line2 [String] - # # @param state [String] - # # @param zip [String] - # # - # def initialize(country:, line1:, city: nil, line2: nil, state: nil, zip: nil, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(country:, line1:, city: nil, line2: nil, state: nil, zip: nil) + # The individual's physical address. Mail receiving locations like PO Boxes and + # PMB's are disallowed. + # + # @param country [String] + # @param line1 [String] + # @param city [String] + # @param line2 [String] + # @param state [String] + # @param zip [String] end end end diff --git a/lib/increase/models/entity_update_industry_code_params.rb b/lib/increase/models/entity_update_industry_code_params.rb index 3c97ce086..dc00f7b26 100644 --- a/lib/increase/models/entity_update_industry_code_params.rb +++ b/lib/increase/models/entity_update_industry_code_params.rb @@ -4,8 +4,7 @@ module Increase module Models # @see Increase::Resources::Entities#update_industry_code class EntityUpdateIndustryCodeParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters # @!attribute industry_code @@ -17,13 +16,9 @@ class EntityUpdateIndustryCodeParams < Increase::Internal::Type::BaseModel # @return [String] required :industry_code, String - # @!parse - # # @param industry_code [String] - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(industry_code:, request_options: {}, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(industry_code:, request_options: {}) + # @param industry_code [String] + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/increase/models/event.rb b/lib/increase/models/event.rb index 6e7a57feb..99e2e7e1d 100644 --- a/lib/increase/models/event.rb +++ b/lib/increase/models/event.rb @@ -42,22 +42,18 @@ class Event < Increase::Internal::Type::BaseModel # @return [Symbol, Increase::Models::Event::Type] required :type, enum: -> { Increase::Models::Event::Type } - # @!parse - # # Events are records of things that happened to objects at Increase. Events are - # # accessible via the List Events endpoint and can be delivered to your application - # # via webhooks. For more information, see our - # # [webhooks guide](https://increase.com/documentation/webhooks). - # # - # # @param id [String] - # # @param associated_object_id [String] - # # @param associated_object_type [String] - # # @param category [Symbol, Increase::Models::Event::Category] - # # @param created_at [Time] - # # @param type [Symbol, Increase::Models::Event::Type] - # # - # def initialize(id:, associated_object_id:, associated_object_type:, category:, created_at:, type:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(id:, associated_object_id:, associated_object_type:, category:, created_at:, type:) + # Events are records of things that happened to objects at Increase. Events are + # accessible via the List Events endpoint and can be delivered to your application + # via webhooks. For more information, see our + # [webhooks guide](https://increase.com/documentation/webhooks). + # + # @param id [String] + # @param associated_object_id [String] + # @param associated_object_type [String] + # @param category [Symbol, Increase::Models::Event::Category] + # @param created_at [Time] + # @param type [Symbol, Increase::Models::Event::Type] # The category of the Event. We may add additional possible values for this enum # over time; your application should be able to handle such additions gracefully. @@ -332,11 +328,8 @@ module Category # Occurs whenever a Wire Transfer is updated. WIRE_TRANSFER_UPDATED = :"wire_transfer.updated" - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # A constant representing the object's type. For this resource it will always be @@ -348,11 +341,8 @@ module Type EVENT = :event - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end diff --git a/lib/increase/models/event_list_params.rb b/lib/increase/models/event_list_params.rb index de1b4cb98..3a8f47e37 100644 --- a/lib/increase/models/event_list_params.rb +++ b/lib/increase/models/event_list_params.rb @@ -4,83 +4,48 @@ module Increase module Models # @see Increase::Resources::Events#list class EventListParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters - # @!attribute [r] associated_object_id + # @!attribute associated_object_id # Filter Events to those belonging to the object with the provided identifier. # # @return [String, nil] optional :associated_object_id, String - # @!parse - # # @return [String] - # attr_writer :associated_object_id - - # @!attribute [r] category + # @!attribute category # # @return [Increase::Models::EventListParams::Category, nil] optional :category, -> { Increase::Models::EventListParams::Category } - # @!parse - # # @return [Increase::Models::EventListParams::Category] - # attr_writer :category - - # @!attribute [r] created_at + # @!attribute created_at # # @return [Increase::Models::EventListParams::CreatedAt, nil] optional :created_at, -> { Increase::Models::EventListParams::CreatedAt } - # @!parse - # # @return [Increase::Models::EventListParams::CreatedAt] - # attr_writer :created_at - - # @!attribute [r] cursor + # @!attribute cursor # Return the page of entries after this one. # # @return [String, nil] optional :cursor, String - # @!parse - # # @return [String] - # attr_writer :cursor - - # @!attribute [r] limit + # @!attribute limit # Limit the size of the list that is returned. The default (and maximum) is 100 # objects. # # @return [Integer, nil] optional :limit, Integer - # @!parse - # # @return [Integer] - # attr_writer :limit - - # @!parse - # # @param associated_object_id [String] - # # @param category [Increase::Models::EventListParams::Category] - # # @param created_at [Increase::Models::EventListParams::CreatedAt] - # # @param cursor [String] - # # @param limit [Integer] - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize( - # associated_object_id: nil, - # category: nil, - # created_at: nil, - # cursor: nil, - # limit: nil, - # request_options: {}, - # ** - # ) - # super - # end - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(associated_object_id: nil, category: nil, created_at: nil, cursor: nil, limit: nil, request_options: {}) + # @param associated_object_id [String] + # @param category [Increase::Models::EventListParams::Category] + # @param created_at [Increase::Models::EventListParams::CreatedAt] + # @param cursor [String] + # @param limit [Integer] + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] class Category < Increase::Internal::Type::BaseModel - # @!attribute [r] in_ + # @!attribute in_ # Filter Events for those with the specified category or categories. For GET # requests, this should be encoded as a comma-delimited string, such as # `?in=one,two,three`. @@ -90,16 +55,8 @@ class Category < Increase::Internal::Type::BaseModel -> { Increase::Internal::Type::ArrayOf[enum: Increase::Models::EventListParams::Category::In] }, api_name: :in - # @!parse - # # @return [Array] - # attr_writer :in_ - - # @!parse - # # @param in_ [Array] - # # - # def initialize(in_: nil, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(in_: nil) + # @param in_ [Array] module In extend Increase::Internal::Type::Enum @@ -370,68 +327,45 @@ module In # Occurs whenever a Wire Transfer is updated. WIRE_TRANSFER_UPDATED = :"wire_transfer.updated" - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end class CreatedAt < Increase::Internal::Type::BaseModel - # @!attribute [r] after + # @!attribute after # Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) # timestamp. # # @return [Time, nil] optional :after, Time - # @!parse - # # @return [Time] - # attr_writer :after - - # @!attribute [r] before + # @!attribute before # Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) # timestamp. # # @return [Time, nil] optional :before, Time - # @!parse - # # @return [Time] - # attr_writer :before - - # @!attribute [r] on_or_after + # @!attribute on_or_after # Return results on or after this # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. # # @return [Time, nil] optional :on_or_after, Time - # @!parse - # # @return [Time] - # attr_writer :on_or_after - - # @!attribute [r] on_or_before + # @!attribute on_or_before # Return results on or before this # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. # # @return [Time, nil] optional :on_or_before, Time - # @!parse - # # @return [Time] - # attr_writer :on_or_before - - # @!parse - # # @param after [Time] - # # @param before [Time] - # # @param on_or_after [Time] - # # @param on_or_before [Time] - # # - # def initialize(after: nil, before: nil, on_or_after: nil, on_or_before: nil, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(after: nil, before: nil, on_or_after: nil, on_or_before: nil) + # @param after [Time] + # @param before [Time] + # @param on_or_after [Time] + # @param on_or_before [Time] end end end diff --git a/lib/increase/models/event_retrieve_params.rb b/lib/increase/models/event_retrieve_params.rb index c3a51a54c..661abaa39 100644 --- a/lib/increase/models/event_retrieve_params.rb +++ b/lib/increase/models/event_retrieve_params.rb @@ -4,16 +4,11 @@ module Increase module Models # @see Increase::Resources::Events#retrieve class EventRetrieveParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters - # @!parse - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(request_options: {}, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(request_options: {}) + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/increase/models/event_subscription.rb b/lib/increase/models/event_subscription.rb index 48ccaaebf..882bb0d53 100644 --- a/lib/increase/models/event_subscription.rb +++ b/lib/increase/models/event_subscription.rb @@ -59,38 +59,22 @@ class EventSubscription < Increase::Internal::Type::BaseModel # @return [String] required :url, String - # @!parse - # # Webhooks are event notifications we send to you by HTTPS POST requests. Event - # # Subscriptions are how you configure your application to listen for them. You can - # # create an Event Subscription through your - # # [developer dashboard](https://dashboard.increase.com/developers/webhooks) or the - # # API. For more information, see our - # # [webhooks guide](https://increase.com/documentation/webhooks). - # # - # # @param id [String] - # # @param created_at [Time] - # # @param idempotency_key [String, nil] - # # @param oauth_connection_id [String, nil] - # # @param selected_event_category [Symbol, Increase::Models::EventSubscription::SelectedEventCategory, nil] - # # @param status [Symbol, Increase::Models::EventSubscription::Status] - # # @param type [Symbol, Increase::Models::EventSubscription::Type] - # # @param url [String] - # # - # def initialize( - # id:, - # created_at:, - # idempotency_key:, - # oauth_connection_id:, - # selected_event_category:, - # status:, - # type:, - # url:, - # ** - # ) - # super - # end - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(id:, created_at:, idempotency_key:, oauth_connection_id:, selected_event_category:, status:, type:, url:) + # Webhooks are event notifications we send to you by HTTPS POST requests. Event + # Subscriptions are how you configure your application to listen for them. You can + # create an Event Subscription through your + # [developer dashboard](https://dashboard.increase.com/developers/webhooks) or the + # API. For more information, see our + # [webhooks guide](https://increase.com/documentation/webhooks). + # + # @param id [String] + # @param created_at [Time] + # @param idempotency_key [String, nil] + # @param oauth_connection_id [String, nil] + # @param selected_event_category [Symbol, Increase::Models::EventSubscription::SelectedEventCategory, nil] + # @param status [Symbol, Increase::Models::EventSubscription::Status] + # @param type [Symbol, Increase::Models::EventSubscription::Type] + # @param url [String] # If specified, this subscription will only receive webhooks for Events with the # specified `category`. @@ -365,11 +349,8 @@ module SelectedEventCategory # Occurs whenever a Wire Transfer is updated. WIRE_TRANSFER_UPDATED = :"wire_transfer.updated" - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # This indicates if we'll send notifications to this subscription. @@ -390,11 +371,8 @@ module Status # The subscription is temporarily disabled due to delivery errors and Events will not be delivered. REQUIRES_ATTENTION = :requires_attention - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # A constant representing the object's type. For this resource it will always be @@ -406,11 +384,8 @@ module Type EVENT_SUBSCRIPTION = :event_subscription - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end diff --git a/lib/increase/models/event_subscription_create_params.rb b/lib/increase/models/event_subscription_create_params.rb index 86c531cfa..617082935 100644 --- a/lib/increase/models/event_subscription_create_params.rb +++ b/lib/increase/models/event_subscription_create_params.rb @@ -4,8 +4,7 @@ module Increase module Models # @see Increase::Resources::EventSubscriptions#create class EventSubscriptionCreateParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters # @!attribute url @@ -14,18 +13,14 @@ class EventSubscriptionCreateParams < Increase::Internal::Type::BaseModel # @return [String] required :url, String - # @!attribute [r] oauth_connection_id + # @!attribute oauth_connection_id # If specified, this subscription will only receive webhooks for Events associated # with the specified OAuth Connection. # # @return [String, nil] optional :oauth_connection_id, String - # @!parse - # # @return [String] - # attr_writer :oauth_connection_id - - # @!attribute [r] selected_event_category + # @!attribute selected_event_category # If specified, this subscription will only receive webhooks for Events with the # specified `category`. # @@ -33,31 +28,19 @@ class EventSubscriptionCreateParams < Increase::Internal::Type::BaseModel optional :selected_event_category, enum: -> { Increase::Models::EventSubscriptionCreateParams::SelectedEventCategory } - # @!parse - # # @return [Symbol, Increase::Models::EventSubscriptionCreateParams::SelectedEventCategory] - # attr_writer :selected_event_category - - # @!attribute [r] shared_secret + # @!attribute shared_secret # The key that will be used to sign webhooks. If no value is passed, a random # string will be used as default. # # @return [String, nil] optional :shared_secret, String - # @!parse - # # @return [String] - # attr_writer :shared_secret - - # @!parse - # # @param url [String] - # # @param oauth_connection_id [String] - # # @param selected_event_category [Symbol, Increase::Models::EventSubscriptionCreateParams::SelectedEventCategory] - # # @param shared_secret [String] - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(url:, oauth_connection_id: nil, selected_event_category: nil, shared_secret: nil, request_options: {}, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(url:, oauth_connection_id: nil, selected_event_category: nil, shared_secret: nil, request_options: {}) + # @param url [String] + # @param oauth_connection_id [String] + # @param selected_event_category [Symbol, Increase::Models::EventSubscriptionCreateParams::SelectedEventCategory] + # @param shared_secret [String] + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] # If specified, this subscription will only receive webhooks for Events with the # specified `category`. @@ -330,11 +313,8 @@ module SelectedEventCategory # Occurs whenever a Wire Transfer is updated. WIRE_TRANSFER_UPDATED = :"wire_transfer.updated" - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end diff --git a/lib/increase/models/event_subscription_list_params.rb b/lib/increase/models/event_subscription_list_params.rb index 876d0129e..9b39377bb 100644 --- a/lib/increase/models/event_subscription_list_params.rb +++ b/lib/increase/models/event_subscription_list_params.rb @@ -4,21 +4,16 @@ module Increase module Models # @see Increase::Resources::EventSubscriptions#list class EventSubscriptionListParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters - # @!attribute [r] cursor + # @!attribute cursor # Return the page of entries after this one. # # @return [String, nil] optional :cursor, String - # @!parse - # # @return [String] - # attr_writer :cursor - - # @!attribute [r] idempotency_key + # @!attribute idempotency_key # Filter records to the one with the specified `idempotency_key` you chose for # that object. This value is unique across Increase and is used to ensure that a # request is only processed once. Learn more about @@ -27,30 +22,18 @@ class EventSubscriptionListParams < Increase::Internal::Type::BaseModel # @return [String, nil] optional :idempotency_key, String - # @!parse - # # @return [String] - # attr_writer :idempotency_key - - # @!attribute [r] limit + # @!attribute limit # Limit the size of the list that is returned. The default (and maximum) is 100 # objects. # # @return [Integer, nil] optional :limit, Integer - # @!parse - # # @return [Integer] - # attr_writer :limit - - # @!parse - # # @param cursor [String] - # # @param idempotency_key [String] - # # @param limit [Integer] - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(cursor: nil, idempotency_key: nil, limit: nil, request_options: {}, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(cursor: nil, idempotency_key: nil, limit: nil, request_options: {}) + # @param cursor [String] + # @param idempotency_key [String] + # @param limit [Integer] + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/increase/models/event_subscription_retrieve_params.rb b/lib/increase/models/event_subscription_retrieve_params.rb index c1e52cafa..b2cf20983 100644 --- a/lib/increase/models/event_subscription_retrieve_params.rb +++ b/lib/increase/models/event_subscription_retrieve_params.rb @@ -4,16 +4,11 @@ module Increase module Models # @see Increase::Resources::EventSubscriptions#retrieve class EventSubscriptionRetrieveParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters - # @!parse - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(request_options: {}, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(request_options: {}) + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/increase/models/event_subscription_update_params.rb b/lib/increase/models/event_subscription_update_params.rb index e32f81d72..ed91c7459 100644 --- a/lib/increase/models/event_subscription_update_params.rb +++ b/lib/increase/models/event_subscription_update_params.rb @@ -4,27 +4,18 @@ module Increase module Models # @see Increase::Resources::EventSubscriptions#update class EventSubscriptionUpdateParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters - # @!attribute [r] status + # @!attribute status # The status to update the Event Subscription with. # # @return [Symbol, Increase::Models::EventSubscriptionUpdateParams::Status, nil] optional :status, enum: -> { Increase::Models::EventSubscriptionUpdateParams::Status } - # @!parse - # # @return [Symbol, Increase::Models::EventSubscriptionUpdateParams::Status] - # attr_writer :status - - # @!parse - # # @param status [Symbol, Increase::Models::EventSubscriptionUpdateParams::Status] - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(status: nil, request_options: {}, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(status: nil, request_options: {}) + # @param status [Symbol, Increase::Models::EventSubscriptionUpdateParams::Status] + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] # The status to update the Event Subscription with. module Status @@ -39,11 +30,8 @@ module Status # The subscription is permanently disabled and Events will not be delivered. DELETED = :deleted - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end diff --git a/lib/increase/models/export.rb b/lib/increase/models/export.rb index 10bf5feb0..9f26789e4 100644 --- a/lib/increase/models/export.rb +++ b/lib/increase/models/export.rb @@ -58,25 +58,21 @@ class Export < Increase::Internal::Type::BaseModel # @return [Symbol, Increase::Models::Export::Type] required :type, enum: -> { Increase::Models::Export::Type } - # @!parse - # # Exports are batch summaries of your Increase data. You can make them from the - # # API or dashboard. Since they can take a while, they are generated - # # asynchronously. We send a webhook when they are ready. For more information, - # # please read our - # # [Exports documentation](https://increase.com/documentation/exports). - # # - # # @param id [String] - # # @param category [Symbol, Increase::Models::Export::Category] - # # @param created_at [Time] - # # @param file_download_url [String, nil] - # # @param file_id [String, nil] - # # @param idempotency_key [String, nil] - # # @param status [Symbol, Increase::Models::Export::Status] - # # @param type [Symbol, Increase::Models::Export::Type] - # # - # def initialize(id:, category:, created_at:, file_download_url:, file_id:, idempotency_key:, status:, type:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(id:, category:, created_at:, file_download_url:, file_id:, idempotency_key:, status:, type:) + # Exports are batch summaries of your Increase data. You can make them from the + # API or dashboard. Since they can take a while, they are generated + # asynchronously. We send a webhook when they are ready. For more information, + # please read our + # [Exports documentation](https://increase.com/documentation/exports). + # + # @param id [String] + # @param category [Symbol, Increase::Models::Export::Category] + # @param created_at [Time] + # @param file_download_url [String, nil] + # @param file_id [String, nil] + # @param idempotency_key [String, nil] + # @param status [Symbol, Increase::Models::Export::Status] + # @param type [Symbol, Increase::Models::Export::Type] # The category of the Export. We may add additional possible values for this enum # over time; your application should be able to handle that gracefully. @@ -106,11 +102,8 @@ module Category # Certain dashboard tables are available as CSV exports. This export cannot be created via the API. DASHBOARD_TABLE_CSV = :dashboard_table_csv - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # The status of the Export. @@ -128,11 +121,8 @@ module Status # The export failed to generate. Increase will reach out to you to resolve the issue. FAILED = :failed - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # A constant representing the object's type. For this resource it will always be @@ -144,11 +134,8 @@ module Type EXPORT = :export - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end diff --git a/lib/increase/models/export_create_params.rb b/lib/increase/models/export_create_params.rb index 883189cd6..6c7246c9d 100644 --- a/lib/increase/models/export_create_params.rb +++ b/lib/increase/models/export_create_params.rb @@ -4,8 +4,7 @@ module Increase module Models # @see Increase::Resources::Exports#create class ExportCreateParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters # @!attribute category @@ -14,29 +13,21 @@ class ExportCreateParams < Increase::Internal::Type::BaseModel # @return [Symbol, Increase::Models::ExportCreateParams::Category] required :category, enum: -> { Increase::Models::ExportCreateParams::Category } - # @!attribute [r] account_statement_ofx + # @!attribute account_statement_ofx # Options for the created export. Required if `category` is equal to # `account_statement_ofx`. # # @return [Increase::Models::ExportCreateParams::AccountStatementOfx, nil] optional :account_statement_ofx, -> { Increase::Models::ExportCreateParams::AccountStatementOfx } - # @!parse - # # @return [Increase::Models::ExportCreateParams::AccountStatementOfx] - # attr_writer :account_statement_ofx - - # @!attribute [r] balance_csv + # @!attribute balance_csv # Options for the created export. Required if `category` is equal to # `balance_csv`. # # @return [Increase::Models::ExportCreateParams::BalanceCsv, nil] optional :balance_csv, -> { Increase::Models::ExportCreateParams::BalanceCsv } - # @!parse - # # @return [Increase::Models::ExportCreateParams::BalanceCsv] - # attr_writer :balance_csv - - # @!attribute [r] bookkeeping_account_balance_csv + # @!attribute bookkeeping_account_balance_csv # Options for the created export. Required if `category` is equal to # `bookkeeping_account_balance_csv`. # @@ -44,66 +35,34 @@ class ExportCreateParams < Increase::Internal::Type::BaseModel optional :bookkeeping_account_balance_csv, -> { Increase::Models::ExportCreateParams::BookkeepingAccountBalanceCsv } - # @!parse - # # @return [Increase::Models::ExportCreateParams::BookkeepingAccountBalanceCsv] - # attr_writer :bookkeeping_account_balance_csv - - # @!attribute [r] entity_csv + # @!attribute entity_csv # Options for the created export. Required if `category` is equal to `entity_csv`. # # @return [Increase::Models::ExportCreateParams::EntityCsv, nil] optional :entity_csv, -> { Increase::Models::ExportCreateParams::EntityCsv } - # @!parse - # # @return [Increase::Models::ExportCreateParams::EntityCsv] - # attr_writer :entity_csv - - # @!attribute [r] transaction_csv + # @!attribute transaction_csv # Options for the created export. Required if `category` is equal to # `transaction_csv`. # # @return [Increase::Models::ExportCreateParams::TransactionCsv, nil] optional :transaction_csv, -> { Increase::Models::ExportCreateParams::TransactionCsv } - # @!parse - # # @return [Increase::Models::ExportCreateParams::TransactionCsv] - # attr_writer :transaction_csv - - # @!attribute [r] vendor_csv + # @!attribute vendor_csv # Options for the created export. Required if `category` is equal to `vendor_csv`. # # @return [Object, nil] optional :vendor_csv, Increase::Internal::Type::Unknown - # @!parse - # # @return [Object] - # attr_writer :vendor_csv - - # @!parse - # # @param category [Symbol, Increase::Models::ExportCreateParams::Category] - # # @param account_statement_ofx [Increase::Models::ExportCreateParams::AccountStatementOfx] - # # @param balance_csv [Increase::Models::ExportCreateParams::BalanceCsv] - # # @param bookkeeping_account_balance_csv [Increase::Models::ExportCreateParams::BookkeepingAccountBalanceCsv] - # # @param entity_csv [Increase::Models::ExportCreateParams::EntityCsv] - # # @param transaction_csv [Increase::Models::ExportCreateParams::TransactionCsv] - # # @param vendor_csv [Object] - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize( - # category:, - # account_statement_ofx: nil, - # balance_csv: nil, - # bookkeeping_account_balance_csv: nil, - # entity_csv: nil, - # transaction_csv: nil, - # vendor_csv: nil, - # request_options: {}, - # ** - # ) - # super - # end - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(category:, account_statement_ofx: nil, balance_csv: nil, bookkeeping_account_balance_csv: nil, entity_csv: nil, transaction_csv: nil, vendor_csv: nil, request_options: {}) + # @param category [Symbol, Increase::Models::ExportCreateParams::Category] + # @param account_statement_ofx [Increase::Models::ExportCreateParams::AccountStatementOfx] + # @param balance_csv [Increase::Models::ExportCreateParams::BalanceCsv] + # @param bookkeeping_account_balance_csv [Increase::Models::ExportCreateParams::BookkeepingAccountBalanceCsv] + # @param entity_csv [Increase::Models::ExportCreateParams::EntityCsv] + # @param transaction_csv [Increase::Models::ExportCreateParams::TransactionCsv] + # @param vendor_csv [Object] + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] # The type of Export to create. module Category @@ -127,11 +86,8 @@ module Category # Export a CSV of vendors added to the third-party risk management dashboard. VENDOR_CSV = :vendor_csv - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end class AccountStatementOfx < Increase::Internal::Type::BaseModel @@ -141,301 +97,197 @@ class AccountStatementOfx < Increase::Internal::Type::BaseModel # @return [String] required :account_id, String - # @!attribute [r] created_at + # @!attribute created_at # Filter results by time range on the `created_at` attribute. # # @return [Increase::Models::ExportCreateParams::AccountStatementOfx::CreatedAt, nil] optional :created_at, -> { Increase::Models::ExportCreateParams::AccountStatementOfx::CreatedAt } - # @!parse - # # @return [Increase::Models::ExportCreateParams::AccountStatementOfx::CreatedAt] - # attr_writer :created_at - - # @!parse - # # Options for the created export. Required if `category` is equal to - # # `account_statement_ofx`. - # # - # # @param account_id [String] - # # @param created_at [Increase::Models::ExportCreateParams::AccountStatementOfx::CreatedAt] - # # - # def initialize(account_id:, created_at: nil, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(account_id:, created_at: nil) + # Options for the created export. Required if `category` is equal to + # `account_statement_ofx`. + # + # @param account_id [String] + # @param created_at [Increase::Models::ExportCreateParams::AccountStatementOfx::CreatedAt] # @see Increase::Models::ExportCreateParams::AccountStatementOfx#created_at class CreatedAt < Increase::Internal::Type::BaseModel - # @!attribute [r] after + # @!attribute after # Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) # timestamp. # # @return [Time, nil] optional :after, Time - # @!parse - # # @return [Time] - # attr_writer :after - - # @!attribute [r] before + # @!attribute before # Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) # timestamp. # # @return [Time, nil] optional :before, Time - # @!parse - # # @return [Time] - # attr_writer :before - - # @!attribute [r] on_or_after + # @!attribute on_or_after # Return results on or after this # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. # # @return [Time, nil] optional :on_or_after, Time - # @!parse - # # @return [Time] - # attr_writer :on_or_after - - # @!attribute [r] on_or_before + # @!attribute on_or_before # Return results on or before this # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. # # @return [Time, nil] optional :on_or_before, Time - # @!parse - # # @return [Time] - # attr_writer :on_or_before - - # @!parse - # # Filter results by time range on the `created_at` attribute. - # # - # # @param after [Time] - # # @param before [Time] - # # @param on_or_after [Time] - # # @param on_or_before [Time] - # # - # def initialize(after: nil, before: nil, on_or_after: nil, on_or_before: nil, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(after: nil, before: nil, on_or_after: nil, on_or_before: nil) + # Filter results by time range on the `created_at` attribute. + # + # @param after [Time] + # @param before [Time] + # @param on_or_after [Time] + # @param on_or_before [Time] end end class BalanceCsv < Increase::Internal::Type::BaseModel - # @!attribute [r] account_id + # @!attribute account_id # Filter exported Transactions to the specified Account. # # @return [String, nil] optional :account_id, String - # @!parse - # # @return [String] - # attr_writer :account_id - - # @!attribute [r] created_at + # @!attribute created_at # Filter results by time range on the `created_at` attribute. # # @return [Increase::Models::ExportCreateParams::BalanceCsv::CreatedAt, nil] optional :created_at, -> { Increase::Models::ExportCreateParams::BalanceCsv::CreatedAt } - # @!parse - # # @return [Increase::Models::ExportCreateParams::BalanceCsv::CreatedAt] - # attr_writer :created_at - - # @!attribute [r] program_id + # @!attribute program_id # Filter exported Transactions to the specified Program. # # @return [String, nil] optional :program_id, String - # @!parse - # # @return [String] - # attr_writer :program_id - - # @!parse - # # Options for the created export. Required if `category` is equal to - # # `balance_csv`. - # # - # # @param account_id [String] - # # @param created_at [Increase::Models::ExportCreateParams::BalanceCsv::CreatedAt] - # # @param program_id [String] - # # - # def initialize(account_id: nil, created_at: nil, program_id: nil, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(account_id: nil, created_at: nil, program_id: nil) + # Options for the created export. Required if `category` is equal to + # `balance_csv`. + # + # @param account_id [String] + # @param created_at [Increase::Models::ExportCreateParams::BalanceCsv::CreatedAt] + # @param program_id [String] # @see Increase::Models::ExportCreateParams::BalanceCsv#created_at class CreatedAt < Increase::Internal::Type::BaseModel - # @!attribute [r] after + # @!attribute after # Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) # timestamp. # # @return [Time, nil] optional :after, Time - # @!parse - # # @return [Time] - # attr_writer :after - - # @!attribute [r] before + # @!attribute before # Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) # timestamp. # # @return [Time, nil] optional :before, Time - # @!parse - # # @return [Time] - # attr_writer :before - - # @!attribute [r] on_or_after + # @!attribute on_or_after # Return results on or after this # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. # # @return [Time, nil] optional :on_or_after, Time - # @!parse - # # @return [Time] - # attr_writer :on_or_after - - # @!attribute [r] on_or_before + # @!attribute on_or_before # Return results on or before this # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. # # @return [Time, nil] optional :on_or_before, Time - # @!parse - # # @return [Time] - # attr_writer :on_or_before - - # @!parse - # # Filter results by time range on the `created_at` attribute. - # # - # # @param after [Time] - # # @param before [Time] - # # @param on_or_after [Time] - # # @param on_or_before [Time] - # # - # def initialize(after: nil, before: nil, on_or_after: nil, on_or_before: nil, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(after: nil, before: nil, on_or_after: nil, on_or_before: nil) + # Filter results by time range on the `created_at` attribute. + # + # @param after [Time] + # @param before [Time] + # @param on_or_after [Time] + # @param on_or_before [Time] end end class BookkeepingAccountBalanceCsv < Increase::Internal::Type::BaseModel - # @!attribute [r] bookkeeping_account_id + # @!attribute bookkeeping_account_id # Filter exported Transactions to the specified Bookkeeping Account. # # @return [String, nil] optional :bookkeeping_account_id, String - # @!parse - # # @return [String] - # attr_writer :bookkeeping_account_id - - # @!attribute [r] created_at + # @!attribute created_at # Filter results by time range on the `created_at` attribute. # # @return [Increase::Models::ExportCreateParams::BookkeepingAccountBalanceCsv::CreatedAt, nil] optional :created_at, -> { Increase::Models::ExportCreateParams::BookkeepingAccountBalanceCsv::CreatedAt } - # @!parse - # # @return [Increase::Models::ExportCreateParams::BookkeepingAccountBalanceCsv::CreatedAt] - # attr_writer :created_at - - # @!parse - # # Options for the created export. Required if `category` is equal to - # # `bookkeeping_account_balance_csv`. - # # - # # @param bookkeeping_account_id [String] - # # @param created_at [Increase::Models::ExportCreateParams::BookkeepingAccountBalanceCsv::CreatedAt] - # # - # def initialize(bookkeeping_account_id: nil, created_at: nil, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(bookkeeping_account_id: nil, created_at: nil) + # Options for the created export. Required if `category` is equal to + # `bookkeeping_account_balance_csv`. + # + # @param bookkeeping_account_id [String] + # @param created_at [Increase::Models::ExportCreateParams::BookkeepingAccountBalanceCsv::CreatedAt] # @see Increase::Models::ExportCreateParams::BookkeepingAccountBalanceCsv#created_at class CreatedAt < Increase::Internal::Type::BaseModel - # @!attribute [r] after + # @!attribute after # Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) # timestamp. # # @return [Time, nil] optional :after, Time - # @!parse - # # @return [Time] - # attr_writer :after - - # @!attribute [r] before + # @!attribute before # Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) # timestamp. # # @return [Time, nil] optional :before, Time - # @!parse - # # @return [Time] - # attr_writer :before - - # @!attribute [r] on_or_after + # @!attribute on_or_after # Return results on or after this # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. # # @return [Time, nil] optional :on_or_after, Time - # @!parse - # # @return [Time] - # attr_writer :on_or_after - - # @!attribute [r] on_or_before + # @!attribute on_or_before # Return results on or before this # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. # # @return [Time, nil] optional :on_or_before, Time - # @!parse - # # @return [Time] - # attr_writer :on_or_before - - # @!parse - # # Filter results by time range on the `created_at` attribute. - # # - # # @param after [Time] - # # @param before [Time] - # # @param on_or_after [Time] - # # @param on_or_before [Time] - # # - # def initialize(after: nil, before: nil, on_or_after: nil, on_or_before: nil, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(after: nil, before: nil, on_or_after: nil, on_or_before: nil) + # Filter results by time range on the `created_at` attribute. + # + # @param after [Time] + # @param before [Time] + # @param on_or_after [Time] + # @param on_or_before [Time] end end class EntityCsv < Increase::Internal::Type::BaseModel - # @!attribute [r] status + # @!attribute status # Entity statuses to filter by. # # @return [Increase::Models::ExportCreateParams::EntityCsv::Status, nil] optional :status, -> { Increase::Models::ExportCreateParams::EntityCsv::Status } - # @!parse - # # @return [Increase::Models::ExportCreateParams::EntityCsv::Status] - # attr_writer :status - - # @!parse - # # Options for the created export. Required if `category` is equal to `entity_csv`. - # # - # # @param status [Increase::Models::ExportCreateParams::EntityCsv::Status] - # # - # def initialize(status: nil, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(status: nil) + # Options for the created export. Required if `category` is equal to `entity_csv`. + # + # @param status [Increase::Models::ExportCreateParams::EntityCsv::Status] # @see Increase::Models::ExportCreateParams::EntityCsv#status class Status < Increase::Internal::Type::BaseModel @@ -448,14 +300,10 @@ class Status < Increase::Internal::Type::BaseModel -> { Increase::Internal::Type::ArrayOf[enum: Increase::Models::ExportCreateParams::EntityCsv::Status::In] }, api_name: :in - # @!parse - # # Entity statuses to filter by. - # # - # # @param in_ [Array] - # # - # def initialize(in_:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(in_:) + # Entity statuses to filter by. + # + # @param in_ [Array] module In extend Increase::Internal::Type::Enum @@ -469,115 +317,76 @@ module In # The entity is temporarily disabled and cannot be used for financial activity. DISABLED = :disabled - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end class TransactionCsv < Increase::Internal::Type::BaseModel - # @!attribute [r] account_id + # @!attribute account_id # Filter exported Transactions to the specified Account. # # @return [String, nil] optional :account_id, String - # @!parse - # # @return [String] - # attr_writer :account_id - - # @!attribute [r] created_at + # @!attribute created_at # Filter results by time range on the `created_at` attribute. # # @return [Increase::Models::ExportCreateParams::TransactionCsv::CreatedAt, nil] optional :created_at, -> { Increase::Models::ExportCreateParams::TransactionCsv::CreatedAt } - # @!parse - # # @return [Increase::Models::ExportCreateParams::TransactionCsv::CreatedAt] - # attr_writer :created_at - - # @!attribute [r] program_id + # @!attribute program_id # Filter exported Transactions to the specified Program. # # @return [String, nil] optional :program_id, String - # @!parse - # # @return [String] - # attr_writer :program_id - - # @!parse - # # Options for the created export. Required if `category` is equal to - # # `transaction_csv`. - # # - # # @param account_id [String] - # # @param created_at [Increase::Models::ExportCreateParams::TransactionCsv::CreatedAt] - # # @param program_id [String] - # # - # def initialize(account_id: nil, created_at: nil, program_id: nil, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(account_id: nil, created_at: nil, program_id: nil) + # Options for the created export. Required if `category` is equal to + # `transaction_csv`. + # + # @param account_id [String] + # @param created_at [Increase::Models::ExportCreateParams::TransactionCsv::CreatedAt] + # @param program_id [String] # @see Increase::Models::ExportCreateParams::TransactionCsv#created_at class CreatedAt < Increase::Internal::Type::BaseModel - # @!attribute [r] after + # @!attribute after # Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) # timestamp. # # @return [Time, nil] optional :after, Time - # @!parse - # # @return [Time] - # attr_writer :after - - # @!attribute [r] before + # @!attribute before # Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) # timestamp. # # @return [Time, nil] optional :before, Time - # @!parse - # # @return [Time] - # attr_writer :before - - # @!attribute [r] on_or_after + # @!attribute on_or_after # Return results on or after this # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. # # @return [Time, nil] optional :on_or_after, Time - # @!parse - # # @return [Time] - # attr_writer :on_or_after - - # @!attribute [r] on_or_before + # @!attribute on_or_before # Return results on or before this # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. # # @return [Time, nil] optional :on_or_before, Time - # @!parse - # # @return [Time] - # attr_writer :on_or_before - - # @!parse - # # Filter results by time range on the `created_at` attribute. - # # - # # @param after [Time] - # # @param before [Time] - # # @param on_or_after [Time] - # # @param on_or_before [Time] - # # - # def initialize(after: nil, before: nil, on_or_after: nil, on_or_before: nil, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(after: nil, before: nil, on_or_after: nil, on_or_before: nil) + # Filter results by time range on the `created_at` attribute. + # + # @param after [Time] + # @param before [Time] + # @param on_or_after [Time] + # @param on_or_before [Time] end end end diff --git a/lib/increase/models/export_list_params.rb b/lib/increase/models/export_list_params.rb index f8477b52d..9e0c7e40f 100644 --- a/lib/increase/models/export_list_params.rb +++ b/lib/increase/models/export_list_params.rb @@ -4,39 +4,26 @@ module Increase module Models # @see Increase::Resources::Exports#list class ExportListParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters - # @!attribute [r] category + # @!attribute category # # @return [Increase::Models::ExportListParams::Category, nil] optional :category, -> { Increase::Models::ExportListParams::Category } - # @!parse - # # @return [Increase::Models::ExportListParams::Category] - # attr_writer :category - - # @!attribute [r] created_at + # @!attribute created_at # # @return [Increase::Models::ExportListParams::CreatedAt, nil] optional :created_at, -> { Increase::Models::ExportListParams::CreatedAt } - # @!parse - # # @return [Increase::Models::ExportListParams::CreatedAt] - # attr_writer :created_at - - # @!attribute [r] cursor + # @!attribute cursor # Return the page of entries after this one. # # @return [String, nil] optional :cursor, String - # @!parse - # # @return [String] - # attr_writer :cursor - - # @!attribute [r] idempotency_key + # @!attribute idempotency_key # Filter records to the one with the specified `idempotency_key` you chose for # that object. This value is unique across Increase and is used to ensure that a # request is only processed once. Learn more about @@ -45,56 +32,29 @@ class ExportListParams < Increase::Internal::Type::BaseModel # @return [String, nil] optional :idempotency_key, String - # @!parse - # # @return [String] - # attr_writer :idempotency_key - - # @!attribute [r] limit + # @!attribute limit # Limit the size of the list that is returned. The default (and maximum) is 100 # objects. # # @return [Integer, nil] optional :limit, Integer - # @!parse - # # @return [Integer] - # attr_writer :limit - - # @!attribute [r] status + # @!attribute status # # @return [Increase::Models::ExportListParams::Status, nil] optional :status, -> { Increase::Models::ExportListParams::Status } - # @!parse - # # @return [Increase::Models::ExportListParams::Status] - # attr_writer :status - - # @!parse - # # @param category [Increase::Models::ExportListParams::Category] - # # @param created_at [Increase::Models::ExportListParams::CreatedAt] - # # @param cursor [String] - # # @param idempotency_key [String] - # # @param limit [Integer] - # # @param status [Increase::Models::ExportListParams::Status] - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize( - # category: nil, - # created_at: nil, - # cursor: nil, - # idempotency_key: nil, - # limit: nil, - # status: nil, - # request_options: {}, - # ** - # ) - # super - # end - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(category: nil, created_at: nil, cursor: nil, idempotency_key: nil, limit: nil, status: nil, request_options: {}) + # @param category [Increase::Models::ExportListParams::Category] + # @param created_at [Increase::Models::ExportListParams::CreatedAt] + # @param cursor [String] + # @param idempotency_key [String] + # @param limit [Integer] + # @param status [Increase::Models::ExportListParams::Status] + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] class Category < Increase::Internal::Type::BaseModel - # @!attribute [r] in_ + # @!attribute in_ # Filter Exports for those with the specified category or categories. For GET # requests, this should be encoded as a comma-delimited string, such as # `?in=one,two,three`. @@ -104,16 +64,8 @@ class Category < Increase::Internal::Type::BaseModel -> { Increase::Internal::Type::ArrayOf[enum: Increase::Models::ExportListParams::Category::In] }, api_name: :in - # @!parse - # # @return [Array] - # attr_writer :in_ - - # @!parse - # # @param in_ [Array] - # # - # def initialize(in_: nil, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(in_: nil) + # @param in_ [Array] module In extend Increase::Internal::Type::Enum @@ -139,72 +91,49 @@ module In # Certain dashboard tables are available as CSV exports. This export cannot be created via the API. DASHBOARD_TABLE_CSV = :dashboard_table_csv - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end class CreatedAt < Increase::Internal::Type::BaseModel - # @!attribute [r] after + # @!attribute after # Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) # timestamp. # # @return [Time, nil] optional :after, Time - # @!parse - # # @return [Time] - # attr_writer :after - - # @!attribute [r] before + # @!attribute before # Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) # timestamp. # # @return [Time, nil] optional :before, Time - # @!parse - # # @return [Time] - # attr_writer :before - - # @!attribute [r] on_or_after + # @!attribute on_or_after # Return results on or after this # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. # # @return [Time, nil] optional :on_or_after, Time - # @!parse - # # @return [Time] - # attr_writer :on_or_after - - # @!attribute [r] on_or_before + # @!attribute on_or_before # Return results on or before this # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. # # @return [Time, nil] optional :on_or_before, Time - # @!parse - # # @return [Time] - # attr_writer :on_or_before - - # @!parse - # # @param after [Time] - # # @param before [Time] - # # @param on_or_after [Time] - # # @param on_or_before [Time] - # # - # def initialize(after: nil, before: nil, on_or_after: nil, on_or_before: nil, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(after: nil, before: nil, on_or_after: nil, on_or_before: nil) + # @param after [Time] + # @param before [Time] + # @param on_or_after [Time] + # @param on_or_before [Time] end class Status < Increase::Internal::Type::BaseModel - # @!attribute [r] in_ + # @!attribute in_ # Filter Exports for those with the specified status or statuses. For GET # requests, this should be encoded as a comma-delimited string, such as # `?in=one,two,three`. @@ -214,16 +143,8 @@ class Status < Increase::Internal::Type::BaseModel -> { Increase::Internal::Type::ArrayOf[enum: Increase::Models::ExportListParams::Status::In] }, api_name: :in - # @!parse - # # @return [Array] - # attr_writer :in_ - - # @!parse - # # @param in_ [Array] - # # - # def initialize(in_: nil, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(in_: nil) + # @param in_ [Array] module In extend Increase::Internal::Type::Enum @@ -237,11 +158,8 @@ module In # The export failed to generate. Increase will reach out to you to resolve the issue. FAILED = :failed - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end diff --git a/lib/increase/models/export_retrieve_params.rb b/lib/increase/models/export_retrieve_params.rb index 16f30c48e..74bb6b234 100644 --- a/lib/increase/models/export_retrieve_params.rb +++ b/lib/increase/models/export_retrieve_params.rb @@ -4,16 +4,11 @@ module Increase module Models # @see Increase::Resources::Exports#retrieve class ExportRetrieveParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters - # @!parse - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(request_options: {}, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(request_options: {}) + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/increase/models/external_account.rb b/lib/increase/models/external_account.rb index 2388501e7..ca8968651 100644 --- a/lib/increase/models/external_account.rb +++ b/lib/increase/models/external_account.rb @@ -74,40 +74,21 @@ class ExternalAccount < Increase::Internal::Type::BaseModel # @return [Symbol, Increase::Models::ExternalAccount::VerificationStatus] required :verification_status, enum: -> { Increase::Models::ExternalAccount::VerificationStatus } - # @!parse - # # External Accounts represent accounts at financial institutions other than - # # Increase. You can use this API to store their details for reuse. - # # - # # @param id [String] - # # @param account_holder [Symbol, Increase::Models::ExternalAccount::AccountHolder] - # # @param account_number [String] - # # @param created_at [Time] - # # @param description [String] - # # @param funding [Symbol, Increase::Models::ExternalAccount::Funding] - # # @param idempotency_key [String, nil] - # # @param routing_number [String] - # # @param status [Symbol, Increase::Models::ExternalAccount::Status] - # # @param type [Symbol, Increase::Models::ExternalAccount::Type] - # # @param verification_status [Symbol, Increase::Models::ExternalAccount::VerificationStatus] - # # - # def initialize( - # id:, - # account_holder:, - # account_number:, - # created_at:, - # description:, - # funding:, - # idempotency_key:, - # routing_number:, - # status:, - # type:, - # verification_status:, - # ** - # ) - # super - # end - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(id:, account_holder:, account_number:, created_at:, description:, funding:, idempotency_key:, routing_number:, status:, type:, verification_status:) + # External Accounts represent accounts at financial institutions other than + # Increase. You can use this API to store their details for reuse. + # + # @param id [String] + # @param account_holder [Symbol, Increase::Models::ExternalAccount::AccountHolder] + # @param account_number [String] + # @param created_at [Time] + # @param description [String] + # @param funding [Symbol, Increase::Models::ExternalAccount::Funding] + # @param idempotency_key [String, nil] + # @param routing_number [String] + # @param status [Symbol, Increase::Models::ExternalAccount::Status] + # @param type [Symbol, Increase::Models::ExternalAccount::Type] + # @param verification_status [Symbol, Increase::Models::ExternalAccount::VerificationStatus] # The type of entity that owns the External Account. # @@ -124,11 +105,8 @@ module AccountHolder # It's unknown what kind of entity owns the External Account. UNKNOWN = :unknown - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # The type of the account to which the transfer will be sent. @@ -146,11 +124,8 @@ module Funding # A different type of account. OTHER = :other - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # The External Account's status. @@ -165,11 +140,8 @@ module Status # The External Account is archived and won't appear in the dashboard. ARCHIVED = :archived - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # A constant representing the object's type. For this resource it will always be @@ -181,11 +153,8 @@ module Type EXTERNAL_ACCOUNT = :external_account - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # If you have verified ownership of the External Account. @@ -203,11 +172,8 @@ module VerificationStatus # The External Account is verified. VERIFIED = :verified - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end diff --git a/lib/increase/models/external_account_create_params.rb b/lib/increase/models/external_account_create_params.rb index 716e3ee00..ea1dbb026 100644 --- a/lib/increase/models/external_account_create_params.rb +++ b/lib/increase/models/external_account_create_params.rb @@ -4,8 +4,7 @@ module Increase module Models # @see Increase::Resources::ExternalAccounts#create class ExternalAccountCreateParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters # @!attribute account_number @@ -27,37 +26,25 @@ class ExternalAccountCreateParams < Increase::Internal::Type::BaseModel # @return [String] required :routing_number, String - # @!attribute [r] account_holder + # @!attribute account_holder # The type of entity that owns the External Account. # # @return [Symbol, Increase::Models::ExternalAccountCreateParams::AccountHolder, nil] optional :account_holder, enum: -> { Increase::Models::ExternalAccountCreateParams::AccountHolder } - # @!parse - # # @return [Symbol, Increase::Models::ExternalAccountCreateParams::AccountHolder] - # attr_writer :account_holder - - # @!attribute [r] funding + # @!attribute funding # The type of the destination account. Defaults to `checking`. # # @return [Symbol, Increase::Models::ExternalAccountCreateParams::Funding, nil] optional :funding, enum: -> { Increase::Models::ExternalAccountCreateParams::Funding } - # @!parse - # # @return [Symbol, Increase::Models::ExternalAccountCreateParams::Funding] - # attr_writer :funding - - # @!parse - # # @param account_number [String] - # # @param description [String] - # # @param routing_number [String] - # # @param account_holder [Symbol, Increase::Models::ExternalAccountCreateParams::AccountHolder] - # # @param funding [Symbol, Increase::Models::ExternalAccountCreateParams::Funding] - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(account_number:, description:, routing_number:, account_holder: nil, funding: nil, request_options: {}, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(account_number:, description:, routing_number:, account_holder: nil, funding: nil, request_options: {}) + # @param account_number [String] + # @param description [String] + # @param routing_number [String] + # @param account_holder [Symbol, Increase::Models::ExternalAccountCreateParams::AccountHolder] + # @param funding [Symbol, Increase::Models::ExternalAccountCreateParams::Funding] + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] # The type of entity that owns the External Account. module AccountHolder @@ -72,11 +59,8 @@ module AccountHolder # It's unknown what kind of entity owns the External Account. UNKNOWN = :unknown - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # The type of the destination account. Defaults to `checking`. @@ -92,11 +76,8 @@ module Funding # A different type of account. OTHER = :other - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end diff --git a/lib/increase/models/external_account_list_params.rb b/lib/increase/models/external_account_list_params.rb index f8ada6362..145317405 100644 --- a/lib/increase/models/external_account_list_params.rb +++ b/lib/increase/models/external_account_list_params.rb @@ -4,21 +4,16 @@ module Increase module Models # @see Increase::Resources::ExternalAccounts#list class ExternalAccountListParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters - # @!attribute [r] cursor + # @!attribute cursor # Return the page of entries after this one. # # @return [String, nil] optional :cursor, String - # @!parse - # # @return [String] - # attr_writer :cursor - - # @!attribute [r] idempotency_key + # @!attribute idempotency_key # Filter records to the one with the specified `idempotency_key` you chose for # that object. This value is unique across Increase and is used to ensure that a # request is only processed once. Learn more about @@ -27,54 +22,34 @@ class ExternalAccountListParams < Increase::Internal::Type::BaseModel # @return [String, nil] optional :idempotency_key, String - # @!parse - # # @return [String] - # attr_writer :idempotency_key - - # @!attribute [r] limit + # @!attribute limit # Limit the size of the list that is returned. The default (and maximum) is 100 # objects. # # @return [Integer, nil] optional :limit, Integer - # @!parse - # # @return [Integer] - # attr_writer :limit - - # @!attribute [r] routing_number + # @!attribute routing_number # Filter External Accounts to those with the specified Routing Number. # # @return [String, nil] optional :routing_number, String - # @!parse - # # @return [String] - # attr_writer :routing_number - - # @!attribute [r] status + # @!attribute status # # @return [Increase::Models::ExternalAccountListParams::Status, nil] optional :status, -> { Increase::Models::ExternalAccountListParams::Status } - # @!parse - # # @return [Increase::Models::ExternalAccountListParams::Status] - # attr_writer :status - - # @!parse - # # @param cursor [String] - # # @param idempotency_key [String] - # # @param limit [Integer] - # # @param routing_number [String] - # # @param status [Increase::Models::ExternalAccountListParams::Status] - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(cursor: nil, idempotency_key: nil, limit: nil, routing_number: nil, status: nil, request_options: {}, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(cursor: nil, idempotency_key: nil, limit: nil, routing_number: nil, status: nil, request_options: {}) + # @param cursor [String] + # @param idempotency_key [String] + # @param limit [Integer] + # @param routing_number [String] + # @param status [Increase::Models::ExternalAccountListParams::Status] + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] class Status < Increase::Internal::Type::BaseModel - # @!attribute [r] in_ + # @!attribute in_ # Filter External Accounts for those with the specified status or statuses. For # GET requests, this should be encoded as a comma-delimited string, such as # `?in=one,two,three`. @@ -84,16 +59,8 @@ class Status < Increase::Internal::Type::BaseModel -> { Increase::Internal::Type::ArrayOf[enum: Increase::Models::ExternalAccountListParams::Status::In] }, api_name: :in - # @!parse - # # @return [Array] - # attr_writer :in_ - - # @!parse - # # @param in_ [Array] - # # - # def initialize(in_: nil, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(in_: nil) + # @param in_ [Array] module In extend Increase::Internal::Type::Enum @@ -104,11 +71,8 @@ module In # The External Account is archived and won't appear in the dashboard. ARCHIVED = :archived - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end diff --git a/lib/increase/models/external_account_retrieve_params.rb b/lib/increase/models/external_account_retrieve_params.rb index 5634ced70..0cd173a8a 100644 --- a/lib/increase/models/external_account_retrieve_params.rb +++ b/lib/increase/models/external_account_retrieve_params.rb @@ -4,16 +4,11 @@ module Increase module Models # @see Increase::Resources::ExternalAccounts#retrieve class ExternalAccountRetrieveParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters - # @!parse - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(request_options: {}, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(request_options: {}) + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/increase/models/external_account_update_params.rb b/lib/increase/models/external_account_update_params.rb index f248ec036..1b7f161a8 100644 --- a/lib/increase/models/external_account_update_params.rb +++ b/lib/increase/models/external_account_update_params.rb @@ -4,60 +4,39 @@ module Increase module Models # @see Increase::Resources::ExternalAccounts#update class ExternalAccountUpdateParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters - # @!attribute [r] account_holder + # @!attribute account_holder # The type of entity that owns the External Account. # # @return [Symbol, Increase::Models::ExternalAccountUpdateParams::AccountHolder, nil] optional :account_holder, enum: -> { Increase::Models::ExternalAccountUpdateParams::AccountHolder } - # @!parse - # # @return [Symbol, Increase::Models::ExternalAccountUpdateParams::AccountHolder] - # attr_writer :account_holder - - # @!attribute [r] description + # @!attribute description # The description you choose to give the external account. # # @return [String, nil] optional :description, String - # @!parse - # # @return [String] - # attr_writer :description - - # @!attribute [r] funding + # @!attribute funding # The funding type of the External Account. # # @return [Symbol, Increase::Models::ExternalAccountUpdateParams::Funding, nil] optional :funding, enum: -> { Increase::Models::ExternalAccountUpdateParams::Funding } - # @!parse - # # @return [Symbol, Increase::Models::ExternalAccountUpdateParams::Funding] - # attr_writer :funding - - # @!attribute [r] status + # @!attribute status # The status of the External Account. # # @return [Symbol, Increase::Models::ExternalAccountUpdateParams::Status, nil] optional :status, enum: -> { Increase::Models::ExternalAccountUpdateParams::Status } - # @!parse - # # @return [Symbol, Increase::Models::ExternalAccountUpdateParams::Status] - # attr_writer :status - - # @!parse - # # @param account_holder [Symbol, Increase::Models::ExternalAccountUpdateParams::AccountHolder] - # # @param description [String] - # # @param funding [Symbol, Increase::Models::ExternalAccountUpdateParams::Funding] - # # @param status [Symbol, Increase::Models::ExternalAccountUpdateParams::Status] - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(account_holder: nil, description: nil, funding: nil, status: nil, request_options: {}, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(account_holder: nil, description: nil, funding: nil, status: nil, request_options: {}) + # @param account_holder [Symbol, Increase::Models::ExternalAccountUpdateParams::AccountHolder] + # @param description [String] + # @param funding [Symbol, Increase::Models::ExternalAccountUpdateParams::Funding] + # @param status [Symbol, Increase::Models::ExternalAccountUpdateParams::Status] + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] # The type of entity that owns the External Account. module AccountHolder @@ -69,11 +48,8 @@ module AccountHolder # The External Account is owned by an individual. INDIVIDUAL = :individual - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # The funding type of the External Account. @@ -89,11 +65,8 @@ module Funding # A different type of account. OTHER = :other - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # The status of the External Account. @@ -106,11 +79,8 @@ module Status # The External Account is archived and won't appear in the dashboard. ARCHIVED = :archived - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end diff --git a/lib/increase/models/file.rb b/lib/increase/models/file.rb index f8fa1c14b..aa866809a 100644 --- a/lib/increase/models/file.rb +++ b/lib/increase/models/file.rb @@ -63,25 +63,21 @@ class File < Increase::Internal::Type::BaseModel # @return [Symbol, Increase::Models::File::Type] required :type, enum: -> { Increase::Models::File::Type } - # @!parse - # # Files are objects that represent a file hosted on Increase's servers. The file - # # may have been uploaded by you (for example, when uploading a check image) or it - # # may have been created by Increase (for example, an autogenerated statement PDF). - # # If you need to download a File, create a File Link. - # # - # # @param id [String] - # # @param created_at [Time] - # # @param description [String, nil] - # # @param direction [Symbol, Increase::Models::File::Direction] - # # @param filename [String, nil] - # # @param idempotency_key [String, nil] - # # @param mime_type [String] - # # @param purpose [Symbol, Increase::Models::File::Purpose] - # # @param type [Symbol, Increase::Models::File::Type] - # # - # def initialize(id:, created_at:, description:, direction:, filename:, idempotency_key:, mime_type:, purpose:, type:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(id:, created_at:, description:, direction:, filename:, idempotency_key:, mime_type:, purpose:, type:) + # Files are objects that represent a file hosted on Increase's servers. The file + # may have been uploaded by you (for example, when uploading a check image) or it + # may have been created by Increase (for example, an autogenerated statement PDF). + # If you need to download a File, create a File Link. + # + # @param id [String] + # @param created_at [Time] + # @param description [String, nil] + # @param direction [Symbol, Increase::Models::File::Direction] + # @param filename [String, nil] + # @param idempotency_key [String, nil] + # @param mime_type [String] + # @param purpose [Symbol, Increase::Models::File::Purpose] + # @param type [Symbol, Increase::Models::File::Type] # Whether the File was generated by Increase or by you and sent to Increase. # @@ -95,11 +91,8 @@ module Direction # This File was generated by Increase. FROM_INCREASE = :from_increase - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # What the File will be used for. We may add additional possible values for this @@ -185,11 +178,8 @@ module Purpose # A file containing additional evidence for a Proof of Authorization Request Submission. PROOF_OF_AUTHORIZATION_REQUEST_SUBMISSION = :proof_of_authorization_request_submission - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # A constant representing the object's type. For this resource it will always be @@ -201,11 +191,8 @@ module Type FILE = :file - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end diff --git a/lib/increase/models/file_create_params.rb b/lib/increase/models/file_create_params.rb index 17c1a0cc3..758eab6f7 100644 --- a/lib/increase/models/file_create_params.rb +++ b/lib/increase/models/file_create_params.rb @@ -4,8 +4,7 @@ module Increase module Models # @see Increase::Resources::Files#create class FileCreateParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters # @!attribute file @@ -22,25 +21,17 @@ class FileCreateParams < Increase::Internal::Type::BaseModel # @return [Symbol, Increase::Models::FileCreateParams::Purpose] required :purpose, enum: -> { Increase::Models::FileCreateParams::Purpose } - # @!attribute [r] description + # @!attribute description # The description you choose to give the File. # # @return [String, nil] optional :description, String - # @!parse - # # @return [String] - # attr_writer :description - - # @!parse - # # @param file [Pathname, StringIO] - # # @param purpose [Symbol, Increase::Models::FileCreateParams::Purpose] - # # @param description [String] - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(file:, purpose:, description: nil, request_options: {}, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(file:, purpose:, description: nil, request_options: {}) + # @param file [Pathname, StringIO] + # @param purpose [Symbol, Increase::Models::FileCreateParams::Purpose] + # @param description [String] + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] # What the File will be used for in Increase's systems. module Purpose @@ -94,11 +85,8 @@ module Purpose # A file containing additional evidence for a Proof of Authorization Request Submission. PROOF_OF_AUTHORIZATION_REQUEST_SUBMISSION = :proof_of_authorization_request_submission - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end diff --git a/lib/increase/models/file_link.rb b/lib/increase/models/file_link.rb index 68180fb38..b6861130a 100644 --- a/lib/increase/models/file_link.rb +++ b/lib/increase/models/file_link.rb @@ -53,20 +53,16 @@ class FileLink < Increase::Internal::Type::BaseModel # @return [String] required :unauthenticated_url, String - # @!parse - # # File Links let you generate a URL that can be used to download a File. - # # - # # @param id [String] - # # @param created_at [Time] - # # @param expires_at [Time] - # # @param file_id [String] - # # @param idempotency_key [String, nil] - # # @param type [Symbol, Increase::Models::FileLink::Type] - # # @param unauthenticated_url [String] - # # - # def initialize(id:, created_at:, expires_at:, file_id:, idempotency_key:, type:, unauthenticated_url:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(id:, created_at:, expires_at:, file_id:, idempotency_key:, type:, unauthenticated_url:) + # File Links let you generate a URL that can be used to download a File. + # + # @param id [String] + # @param created_at [Time] + # @param expires_at [Time] + # @param file_id [String] + # @param idempotency_key [String, nil] + # @param type [Symbol, Increase::Models::FileLink::Type] + # @param unauthenticated_url [String] # A constant representing the object's type. For this resource it will always be # `file_link`. @@ -77,11 +73,8 @@ module Type FILE_LINK = :file_link - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end diff --git a/lib/increase/models/file_link_create_params.rb b/lib/increase/models/file_link_create_params.rb index 43edb7b0a..4abffa610 100644 --- a/lib/increase/models/file_link_create_params.rb +++ b/lib/increase/models/file_link_create_params.rb @@ -4,8 +4,7 @@ module Increase module Models # @see Increase::Resources::FileLinks#create class FileLinkCreateParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters # @!attribute file_id @@ -14,25 +13,17 @@ class FileLinkCreateParams < Increase::Internal::Type::BaseModel # @return [String] required :file_id, String - # @!attribute [r] expires_at + # @!attribute expires_at # The time at which the File Link will expire. The default is 1 hour from the time # of the request. The maxiumum is 1 day from the time of the request. # # @return [Time, nil] optional :expires_at, Time - # @!parse - # # @return [Time] - # attr_writer :expires_at - - # @!parse - # # @param file_id [String] - # # @param expires_at [Time] - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(file_id:, expires_at: nil, request_options: {}, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(file_id:, expires_at: nil, request_options: {}) + # @param file_id [String] + # @param expires_at [Time] + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/increase/models/file_list_params.rb b/lib/increase/models/file_list_params.rb index 5232160a9..f336492a2 100644 --- a/lib/increase/models/file_list_params.rb +++ b/lib/increase/models/file_list_params.rb @@ -4,30 +4,21 @@ module Increase module Models # @see Increase::Resources::Files#list class FileListParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters - # @!attribute [r] created_at + # @!attribute created_at # # @return [Increase::Models::FileListParams::CreatedAt, nil] optional :created_at, -> { Increase::Models::FileListParams::CreatedAt } - # @!parse - # # @return [Increase::Models::FileListParams::CreatedAt] - # attr_writer :created_at - - # @!attribute [r] cursor + # @!attribute cursor # Return the page of entries after this one. # # @return [String, nil] optional :cursor, String - # @!parse - # # @return [String] - # attr_writer :cursor - - # @!attribute [r] idempotency_key + # @!attribute idempotency_key # Filter records to the one with the specified `idempotency_key` you chose for # that object. This value is unique across Increase and is used to ensure that a # request is only processed once. Learn more about @@ -36,100 +27,64 @@ class FileListParams < Increase::Internal::Type::BaseModel # @return [String, nil] optional :idempotency_key, String - # @!parse - # # @return [String] - # attr_writer :idempotency_key - - # @!attribute [r] limit + # @!attribute limit # Limit the size of the list that is returned. The default (and maximum) is 100 # objects. # # @return [Integer, nil] optional :limit, Integer - # @!parse - # # @return [Integer] - # attr_writer :limit - - # @!attribute [r] purpose + # @!attribute purpose # # @return [Increase::Models::FileListParams::Purpose, nil] optional :purpose, -> { Increase::Models::FileListParams::Purpose } - # @!parse - # # @return [Increase::Models::FileListParams::Purpose] - # attr_writer :purpose - - # @!parse - # # @param created_at [Increase::Models::FileListParams::CreatedAt] - # # @param cursor [String] - # # @param idempotency_key [String] - # # @param limit [Integer] - # # @param purpose [Increase::Models::FileListParams::Purpose] - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(created_at: nil, cursor: nil, idempotency_key: nil, limit: nil, purpose: nil, request_options: {}, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(created_at: nil, cursor: nil, idempotency_key: nil, limit: nil, purpose: nil, request_options: {}) + # @param created_at [Increase::Models::FileListParams::CreatedAt] + # @param cursor [String] + # @param idempotency_key [String] + # @param limit [Integer] + # @param purpose [Increase::Models::FileListParams::Purpose] + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] class CreatedAt < Increase::Internal::Type::BaseModel - # @!attribute [r] after + # @!attribute after # Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) # timestamp. # # @return [Time, nil] optional :after, Time - # @!parse - # # @return [Time] - # attr_writer :after - - # @!attribute [r] before + # @!attribute before # Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) # timestamp. # # @return [Time, nil] optional :before, Time - # @!parse - # # @return [Time] - # attr_writer :before - - # @!attribute [r] on_or_after + # @!attribute on_or_after # Return results on or after this # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. # # @return [Time, nil] optional :on_or_after, Time - # @!parse - # # @return [Time] - # attr_writer :on_or_after - - # @!attribute [r] on_or_before + # @!attribute on_or_before # Return results on or before this # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. # # @return [Time, nil] optional :on_or_before, Time - # @!parse - # # @return [Time] - # attr_writer :on_or_before - - # @!parse - # # @param after [Time] - # # @param before [Time] - # # @param on_or_after [Time] - # # @param on_or_before [Time] - # # - # def initialize(after: nil, before: nil, on_or_after: nil, on_or_before: nil, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(after: nil, before: nil, on_or_after: nil, on_or_before: nil) + # @param after [Time] + # @param before [Time] + # @param on_or_after [Time] + # @param on_or_before [Time] end class Purpose < Increase::Internal::Type::BaseModel - # @!attribute [r] in_ + # @!attribute in_ # Filter Files for those with the specified purpose or purposes. For GET requests, # this should be encoded as a comma-delimited string, such as `?in=one,two,three`. # @@ -138,16 +93,8 @@ class Purpose < Increase::Internal::Type::BaseModel -> { Increase::Internal::Type::ArrayOf[enum: Increase::Models::FileListParams::Purpose::In] }, api_name: :in - # @!parse - # # @return [Array] - # attr_writer :in_ - - # @!parse - # # @param in_ [Array] - # # - # def initialize(in_: nil, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(in_: nil) + # @param in_ [Array] module In extend Increase::Internal::Type::Enum @@ -227,11 +174,8 @@ module In # A file containing additional evidence for a Proof of Authorization Request Submission. PROOF_OF_AUTHORIZATION_REQUEST_SUBMISSION = :proof_of_authorization_request_submission - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end diff --git a/lib/increase/models/file_retrieve_params.rb b/lib/increase/models/file_retrieve_params.rb index d5ac6467e..8912b1aee 100644 --- a/lib/increase/models/file_retrieve_params.rb +++ b/lib/increase/models/file_retrieve_params.rb @@ -4,16 +4,11 @@ module Increase module Models # @see Increase::Resources::Files#retrieve class FileRetrieveParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters - # @!parse - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(request_options: {}, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(request_options: {}) + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/increase/models/group.rb b/lib/increase/models/group.rb index 353fb31d1..c7f66b1c9 100644 --- a/lib/increase/models/group.rb +++ b/lib/increase/models/group.rb @@ -36,21 +36,17 @@ class Group < Increase::Internal::Type::BaseModel # @return [Symbol, Increase::Models::Group::Type] required :type, enum: -> { Increase::Models::Group::Type } - # @!parse - # # Groups represent organizations using Increase. You can retrieve information - # # about your own organization via the API. More commonly, OAuth platforms can - # # retrieve information about the organizations that have granted them access. - # # Learn more about OAuth [here](https://increase.com/documentation/oauth). - # # - # # @param id [String] - # # @param ach_debit_status [Symbol, Increase::Models::Group::ACHDebitStatus] - # # @param activation_status [Symbol, Increase::Models::Group::ActivationStatus] - # # @param created_at [Time] - # # @param type [Symbol, Increase::Models::Group::Type] - # # - # def initialize(id:, ach_debit_status:, activation_status:, created_at:, type:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(id:, ach_debit_status:, activation_status:, created_at:, type:) + # Groups represent organizations using Increase. You can retrieve information + # about your own organization via the API. More commonly, OAuth platforms can + # retrieve information about the organizations that have granted them access. + # Learn more about OAuth [here](https://increase.com/documentation/oauth). + # + # @param id [String] + # @param ach_debit_status [Symbol, Increase::Models::Group::ACHDebitStatus] + # @param activation_status [Symbol, Increase::Models::Group::ActivationStatus] + # @param created_at [Time] + # @param type [Symbol, Increase::Models::Group::Type] # If the Group is allowed to create ACH debits. # @@ -64,11 +60,8 @@ module ACHDebitStatus # The Group can make ACH debits. ENABLED = :enabled - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # If the Group is activated or not. @@ -83,11 +76,8 @@ module ActivationStatus # The Group is activated. ACTIVATED = :activated - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # A constant representing the object's type. For this resource it will always be @@ -99,11 +89,8 @@ module Type GROUP = :group - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end diff --git a/lib/increase/models/group_retrieve_params.rb b/lib/increase/models/group_retrieve_params.rb index 0c53c165b..1596c2b36 100644 --- a/lib/increase/models/group_retrieve_params.rb +++ b/lib/increase/models/group_retrieve_params.rb @@ -4,16 +4,11 @@ module Increase module Models # @see Increase::Resources::Groups#retrieve class GroupRetrieveParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters - # @!parse - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(request_options: {}, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(request_options: {}) + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/increase/models/inbound_ach_transfer.rb b/lib/increase/models/inbound_ach_transfer.rb index a784d9ae8..d37ffdf92 100644 --- a/lib/increase/models/inbound_ach_transfer.rb +++ b/lib/increase/models/inbound_ach_transfer.rb @@ -181,72 +181,37 @@ class InboundACHTransfer < Increase::Internal::Type::BaseModel # @return [Symbol, Increase::Models::InboundACHTransfer::Type] required :type, enum: -> { Increase::Models::InboundACHTransfer::Type } - # @!parse - # # An Inbound ACH Transfer is an ACH transfer initiated outside of Increase to your - # # account. - # # - # # @param id [String] - # # @param acceptance [Increase::Models::InboundACHTransfer::Acceptance, nil] - # # @param account_id [String] - # # @param account_number_id [String] - # # @param addenda [Increase::Models::InboundACHTransfer::Addenda, nil] - # # @param amount [Integer] - # # @param automatically_resolves_at [Time] - # # @param created_at [Time] - # # @param decline [Increase::Models::InboundACHTransfer::Decline, nil] - # # @param direction [Symbol, Increase::Models::InboundACHTransfer::Direction] - # # @param effective_date [Date] - # # @param expected_settlement_schedule [Symbol, Increase::Models::InboundACHTransfer::ExpectedSettlementSchedule] - # # @param international_addenda [Increase::Models::InboundACHTransfer::InternationalAddenda, nil] - # # @param notification_of_change [Increase::Models::InboundACHTransfer::NotificationOfChange, nil] - # # @param originator_company_descriptive_date [String, nil] - # # @param originator_company_discretionary_data [String, nil] - # # @param originator_company_entry_description [String] - # # @param originator_company_id [String] - # # @param originator_company_name [String] - # # @param originator_routing_number [String] - # # @param receiver_id_number [String, nil] - # # @param receiver_name [String, nil] - # # @param standard_entry_class_code [Symbol, Increase::Models::InboundACHTransfer::StandardEntryClassCode] - # # @param status [Symbol, Increase::Models::InboundACHTransfer::Status] - # # @param trace_number [String] - # # @param transfer_return [Increase::Models::InboundACHTransfer::TransferReturn, nil] - # # @param type [Symbol, Increase::Models::InboundACHTransfer::Type] - # # - # def initialize( - # id:, - # acceptance:, - # account_id:, - # account_number_id:, - # addenda:, - # amount:, - # automatically_resolves_at:, - # created_at:, - # decline:, - # direction:, - # effective_date:, - # expected_settlement_schedule:, - # international_addenda:, - # notification_of_change:, - # originator_company_descriptive_date:, - # originator_company_discretionary_data:, - # originator_company_entry_description:, - # originator_company_id:, - # originator_company_name:, - # originator_routing_number:, - # receiver_id_number:, - # receiver_name:, - # standard_entry_class_code:, - # status:, - # trace_number:, - # transfer_return:, - # type:, - # ** - # ) - # super - # end - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(id:, acceptance:, account_id:, account_number_id:, addenda:, amount:, automatically_resolves_at:, created_at:, decline:, direction:, effective_date:, expected_settlement_schedule:, international_addenda:, notification_of_change:, originator_company_descriptive_date:, originator_company_discretionary_data:, originator_company_entry_description:, originator_company_id:, originator_company_name:, originator_routing_number:, receiver_id_number:, receiver_name:, standard_entry_class_code:, status:, trace_number:, transfer_return:, type:) + # An Inbound ACH Transfer is an ACH transfer initiated outside of Increase to your + # account. + # + # @param id [String] + # @param acceptance [Increase::Models::InboundACHTransfer::Acceptance, nil] + # @param account_id [String] + # @param account_number_id [String] + # @param addenda [Increase::Models::InboundACHTransfer::Addenda, nil] + # @param amount [Integer] + # @param automatically_resolves_at [Time] + # @param created_at [Time] + # @param decline [Increase::Models::InboundACHTransfer::Decline, nil] + # @param direction [Symbol, Increase::Models::InboundACHTransfer::Direction] + # @param effective_date [Date] + # @param expected_settlement_schedule [Symbol, Increase::Models::InboundACHTransfer::ExpectedSettlementSchedule] + # @param international_addenda [Increase::Models::InboundACHTransfer::InternationalAddenda, nil] + # @param notification_of_change [Increase::Models::InboundACHTransfer::NotificationOfChange, nil] + # @param originator_company_descriptive_date [String, nil] + # @param originator_company_discretionary_data [String, nil] + # @param originator_company_entry_description [String] + # @param originator_company_id [String] + # @param originator_company_name [String] + # @param originator_routing_number [String] + # @param receiver_id_number [String, nil] + # @param receiver_name [String, nil] + # @param standard_entry_class_code [Symbol, Increase::Models::InboundACHTransfer::StandardEntryClassCode] + # @param status [Symbol, Increase::Models::InboundACHTransfer::Status] + # @param trace_number [String] + # @param transfer_return [Increase::Models::InboundACHTransfer::TransferReturn, nil] + # @param type [Symbol, Increase::Models::InboundACHTransfer::Type] # @see Increase::Models::InboundACHTransfer#acceptance class Acceptance < Increase::Internal::Type::BaseModel @@ -262,15 +227,11 @@ class Acceptance < Increase::Internal::Type::BaseModel # @return [String] required :transaction_id, String - # @!parse - # # If your transfer is accepted, this will contain details of the acceptance. - # # - # # @param accepted_at [Time] - # # @param transaction_id [String] - # # - # def initialize(accepted_at:, transaction_id:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(accepted_at:, transaction_id:) + # If your transfer is accepted, this will contain details of the acceptance. + # + # @param accepted_at [Time] + # @param transaction_id [String] end # @see Increase::Models::InboundACHTransfer#addenda @@ -287,15 +248,11 @@ class Addenda < Increase::Internal::Type::BaseModel # @return [Increase::Models::InboundACHTransfer::Addenda::Freeform, nil] required :freeform, -> { Increase::Models::InboundACHTransfer::Addenda::Freeform }, nil?: true - # @!parse - # # Additional information sent from the originator. - # # - # # @param category [Symbol, Increase::Models::InboundACHTransfer::Addenda::Category] - # # @param freeform [Increase::Models::InboundACHTransfer::Addenda::Freeform, nil] - # # - # def initialize(category:, freeform:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(category:, freeform:) + # Additional information sent from the originator. + # + # @param category [Symbol, Increase::Models::InboundACHTransfer::Addenda::Category] + # @param freeform [Increase::Models::InboundACHTransfer::Addenda::Freeform, nil] # The type of addendum. # @@ -306,11 +263,8 @@ module Category # Unstructured addendum. FREEFORM = :freeform - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Increase::Models::InboundACHTransfer::Addenda#freeform @@ -322,14 +276,10 @@ class Freeform < Increase::Internal::Type::BaseModel required :entries, -> { Increase::Internal::Type::ArrayOf[Increase::Models::InboundACHTransfer::Addenda::Freeform::Entry] } - # @!parse - # # Unstructured `payment_related_information` passed through by the originator. - # # - # # @param entries [Array] - # # - # def initialize(entries:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(entries:) + # Unstructured `payment_related_information` passed through by the originator. + # + # @param entries [Array] class Entry < Increase::Internal::Type::BaseModel # @!attribute payment_related_information @@ -338,12 +288,8 @@ class Entry < Increase::Internal::Type::BaseModel # @return [String] required :payment_related_information, String - # @!parse - # # @param payment_related_information [String] - # # - # def initialize(payment_related_information:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(payment_related_information:) + # @param payment_related_information [String] end end end @@ -368,16 +314,12 @@ class Decline < Increase::Internal::Type::BaseModel # @return [Symbol, Increase::Models::InboundACHTransfer::Decline::Reason] required :reason, enum: -> { Increase::Models::InboundACHTransfer::Decline::Reason } - # @!parse - # # If your transfer is declined, this will contain details of the decline. - # # - # # @param declined_at [Time] - # # @param declined_transaction_id [String] - # # @param reason [Symbol, Increase::Models::InboundACHTransfer::Decline::Reason] - # # - # def initialize(declined_at:, declined_transaction_id:, reason:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(declined_at:, declined_transaction_id:, reason:) + # If your transfer is declined, this will contain details of the decline. + # + # @param declined_at [Time] + # @param declined_transaction_id [String] + # @param reason [Symbol, Increase::Models::InboundACHTransfer::Decline::Reason] # The reason for the transfer decline. # @@ -438,11 +380,8 @@ module Reason # The corporate customer no longer authorizes this transaction. CORPORATE_CUSTOMER_ADVISED_NOT_AUTHORIZED = :corporate_customer_advised_not_authorized - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -458,11 +397,8 @@ module Direction # Debit DEBIT = :debit - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # The settlement schedule the transfer is expected to follow. @@ -477,11 +413,8 @@ module ExpectedSettlementSchedule # The transfer is expected to settle on a future date. FUTURE_DATED = :future_dated - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Increase::Models::InboundACHTransfer#international_addenda @@ -709,84 +642,43 @@ class InternationalAddenda < Increase::Internal::Type::BaseModel # @return [String] required :receiving_depository_financial_institution_name, String - # @!parse - # # If the Inbound ACH Transfer has a Standard Entry Class Code of IAT, this will - # # contain fields pertaining to the International ACH Transaction. - # # - # # @param destination_country_code [String] - # # @param destination_currency_code [String] - # # @param foreign_exchange_indicator [Symbol, Increase::Models::InboundACHTransfer::InternationalAddenda::ForeignExchangeIndicator] - # # @param foreign_exchange_reference [String, nil] - # # @param foreign_exchange_reference_indicator [Symbol, Increase::Models::InboundACHTransfer::InternationalAddenda::ForeignExchangeReferenceIndicator] - # # @param foreign_payment_amount [Integer] - # # @param foreign_trace_number [String, nil] - # # @param international_transaction_type_code [Symbol, Increase::Models::InboundACHTransfer::InternationalAddenda::InternationalTransactionTypeCode] - # # @param originating_currency_code [String] - # # @param originating_depository_financial_institution_branch_country [String] - # # @param originating_depository_financial_institution_id [String] - # # @param originating_depository_financial_institution_id_qualifier [Symbol, Increase::Models::InboundACHTransfer::InternationalAddenda::OriginatingDepositoryFinancialInstitutionIDQualifier] - # # @param originating_depository_financial_institution_name [String] - # # @param originator_city [String] - # # @param originator_country [String] - # # @param originator_identification [String] - # # @param originator_name [String] - # # @param originator_postal_code [String, nil] - # # @param originator_state_or_province [String, nil] - # # @param originator_street_address [String] - # # @param payment_related_information [String, nil] - # # @param payment_related_information2 [String, nil] - # # @param receiver_city [String] - # # @param receiver_country [String] - # # @param receiver_identification_number [String, nil] - # # @param receiver_postal_code [String, nil] - # # @param receiver_state_or_province [String, nil] - # # @param receiver_street_address [String] - # # @param receiving_company_or_individual_name [String] - # # @param receiving_depository_financial_institution_country [String] - # # @param receiving_depository_financial_institution_id [String] - # # @param receiving_depository_financial_institution_id_qualifier [Symbol, Increase::Models::InboundACHTransfer::InternationalAddenda::ReceivingDepositoryFinancialInstitutionIDQualifier] - # # @param receiving_depository_financial_institution_name [String] - # # - # def initialize( - # destination_country_code:, - # destination_currency_code:, - # foreign_exchange_indicator:, - # foreign_exchange_reference:, - # foreign_exchange_reference_indicator:, - # foreign_payment_amount:, - # foreign_trace_number:, - # international_transaction_type_code:, - # originating_currency_code:, - # originating_depository_financial_institution_branch_country:, - # originating_depository_financial_institution_id:, - # originating_depository_financial_institution_id_qualifier:, - # originating_depository_financial_institution_name:, - # originator_city:, - # originator_country:, - # originator_identification:, - # originator_name:, - # originator_postal_code:, - # originator_state_or_province:, - # originator_street_address:, - # payment_related_information:, - # payment_related_information2:, - # receiver_city:, - # receiver_country:, - # receiver_identification_number:, - # receiver_postal_code:, - # receiver_state_or_province:, - # receiver_street_address:, - # receiving_company_or_individual_name:, - # receiving_depository_financial_institution_country:, - # receiving_depository_financial_institution_id:, - # receiving_depository_financial_institution_id_qualifier:, - # receiving_depository_financial_institution_name:, - # ** - # ) - # super - # end - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(destination_country_code:, destination_currency_code:, foreign_exchange_indicator:, foreign_exchange_reference:, foreign_exchange_reference_indicator:, foreign_payment_amount:, foreign_trace_number:, international_transaction_type_code:, originating_currency_code:, originating_depository_financial_institution_branch_country:, originating_depository_financial_institution_id:, originating_depository_financial_institution_id_qualifier:, originating_depository_financial_institution_name:, originator_city:, originator_country:, originator_identification:, originator_name:, originator_postal_code:, originator_state_or_province:, originator_street_address:, payment_related_information:, payment_related_information2:, receiver_city:, receiver_country:, receiver_identification_number:, receiver_postal_code:, receiver_state_or_province:, receiver_street_address:, receiving_company_or_individual_name:, receiving_depository_financial_institution_country:, receiving_depository_financial_institution_id:, receiving_depository_financial_institution_id_qualifier:, receiving_depository_financial_institution_name:) + # If the Inbound ACH Transfer has a Standard Entry Class Code of IAT, this will + # contain fields pertaining to the International ACH Transaction. + # + # @param destination_country_code [String] + # @param destination_currency_code [String] + # @param foreign_exchange_indicator [Symbol, Increase::Models::InboundACHTransfer::InternationalAddenda::ForeignExchangeIndicator] + # @param foreign_exchange_reference [String, nil] + # @param foreign_exchange_reference_indicator [Symbol, Increase::Models::InboundACHTransfer::InternationalAddenda::ForeignExchangeReferenceIndicator] + # @param foreign_payment_amount [Integer] + # @param foreign_trace_number [String, nil] + # @param international_transaction_type_code [Symbol, Increase::Models::InboundACHTransfer::InternationalAddenda::InternationalTransactionTypeCode] + # @param originating_currency_code [String] + # @param originating_depository_financial_institution_branch_country [String] + # @param originating_depository_financial_institution_id [String] + # @param originating_depository_financial_institution_id_qualifier [Symbol, Increase::Models::InboundACHTransfer::InternationalAddenda::OriginatingDepositoryFinancialInstitutionIDQualifier] + # @param originating_depository_financial_institution_name [String] + # @param originator_city [String] + # @param originator_country [String] + # @param originator_identification [String] + # @param originator_name [String] + # @param originator_postal_code [String, nil] + # @param originator_state_or_province [String, nil] + # @param originator_street_address [String] + # @param payment_related_information [String, nil] + # @param payment_related_information2 [String, nil] + # @param receiver_city [String] + # @param receiver_country [String] + # @param receiver_identification_number [String, nil] + # @param receiver_postal_code [String, nil] + # @param receiver_state_or_province [String, nil] + # @param receiver_street_address [String] + # @param receiving_company_or_individual_name [String] + # @param receiving_depository_financial_institution_country [String] + # @param receiving_depository_financial_institution_id [String] + # @param receiving_depository_financial_institution_id_qualifier [Symbol, Increase::Models::InboundACHTransfer::InternationalAddenda::ReceivingDepositoryFinancialInstitutionIDQualifier] + # @param receiving_depository_financial_institution_name [String] # A description of how the foreign exchange rate was calculated. # @@ -803,11 +695,8 @@ module ForeignExchangeIndicator # The amount was originated and settled as a fixed amount in USD. There is no foreign exchange conversion. FIXED_TO_FIXED = :fixed_to_fixed - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # An instruction of how to interpret the `foreign_exchange_reference` field for @@ -826,11 +715,8 @@ module ForeignExchangeReferenceIndicator # There is no foreign exchange for this transfer, so the `foreign_exchange_reference` field is blank. BLANK = :blank - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # The type of transfer. Set by the originator. @@ -899,11 +785,8 @@ module InternationalTransactionTypeCode # Sent as `WEB` in the Nacha file. INTERNET_INITIATED = :internet_initiated - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # An instruction of how to interpret the @@ -922,11 +805,8 @@ module OriginatingDepositoryFinancialInstitutionIDQualifier # An International Bank Account Number. IBAN = :iban - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # An instruction of how to interpret the @@ -945,11 +825,8 @@ module ReceivingDepositoryFinancialInstitutionIDQualifier # An International Bank Account Number. IBAN = :iban - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -967,16 +844,12 @@ class NotificationOfChange < Increase::Internal::Type::BaseModel # @return [String, nil] required :updated_routing_number, String, nil?: true - # @!parse - # # If you initiate a notification of change in response to the transfer, this will - # # contain its details. - # # - # # @param updated_account_number [String, nil] - # # @param updated_routing_number [String, nil] - # # - # def initialize(updated_account_number:, updated_routing_number:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(updated_account_number:, updated_routing_number:) + # If you initiate a notification of change in response to the transfer, this will + # contain its details. + # + # @param updated_account_number [String, nil] + # @param updated_routing_number [String, nil] end # The Standard Entry Class (SEC) code of the transfer. @@ -1033,11 +906,8 @@ module StandardEntryClassCode # International ACH Transaction (IAT). INTERNATIONAL_ACH_TRANSACTION = :international_ach_transaction - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # The status of the transfer. @@ -1058,11 +928,8 @@ module Status # The Inbound ACH Transfer has been returned. RETURNED = :returned - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Increase::Models::InboundACHTransfer#transfer_return @@ -1085,16 +952,12 @@ class TransferReturn < Increase::Internal::Type::BaseModel # @return [String] required :transaction_id, String - # @!parse - # # If your transfer is returned, this will contain details of the return. - # # - # # @param reason [Symbol, Increase::Models::InboundACHTransfer::TransferReturn::Reason] - # # @param returned_at [Time] - # # @param transaction_id [String] - # # - # def initialize(reason:, returned_at:, transaction_id:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(reason:, returned_at:, transaction_id:) + # If your transfer is returned, this will contain details of the return. + # + # @param reason [Symbol, Increase::Models::InboundACHTransfer::TransferReturn::Reason] + # @param returned_at [Time] + # @param transaction_id [String] # The reason for the transfer return. # @@ -1134,11 +997,8 @@ module Reason # The corporate customer no longer authorizes this transaction. The Nacha return code is R29. CORPORATE_CUSTOMER_ADVISED_NOT_AUTHORIZED = :corporate_customer_advised_not_authorized - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -1151,11 +1011,8 @@ module Type INBOUND_ACH_TRANSFER = :inbound_ach_transfer - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end diff --git a/lib/increase/models/inbound_ach_transfer_create_notification_of_change_params.rb b/lib/increase/models/inbound_ach_transfer_create_notification_of_change_params.rb index 50af8cd76..b21b48cf6 100644 --- a/lib/increase/models/inbound_ach_transfer_create_notification_of_change_params.rb +++ b/lib/increase/models/inbound_ach_transfer_create_notification_of_change_params.rb @@ -4,38 +4,25 @@ module Increase module Models # @see Increase::Resources::InboundACHTransfers#create_notification_of_change class InboundACHTransferCreateNotificationOfChangeParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters - # @!attribute [r] updated_account_number + # @!attribute updated_account_number # The updated account number to send in the notification of change. # # @return [String, nil] optional :updated_account_number, String - # @!parse - # # @return [String] - # attr_writer :updated_account_number - - # @!attribute [r] updated_routing_number + # @!attribute updated_routing_number # The updated routing number to send in the notification of change. # # @return [String, nil] optional :updated_routing_number, String - # @!parse - # # @return [String] - # attr_writer :updated_routing_number - - # @!parse - # # @param updated_account_number [String] - # # @param updated_routing_number [String] - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(updated_account_number: nil, updated_routing_number: nil, request_options: {}, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(updated_account_number: nil, updated_routing_number: nil, request_options: {}) + # @param updated_account_number [String] + # @param updated_routing_number [String] + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/increase/models/inbound_ach_transfer_decline_params.rb b/lib/increase/models/inbound_ach_transfer_decline_params.rb index 4bc2f868a..d26079e16 100644 --- a/lib/increase/models/inbound_ach_transfer_decline_params.rb +++ b/lib/increase/models/inbound_ach_transfer_decline_params.rb @@ -4,11 +4,10 @@ module Increase module Models # @see Increase::Resources::InboundACHTransfers#decline class InboundACHTransferDeclineParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters - # @!attribute [r] reason + # @!attribute reason # The reason why this transfer will be returned. If this parameter is unset, the # return codes will be `payment_stopped` for debits and # `credit_entry_refused_by_receiver` for credits. @@ -16,17 +15,9 @@ class InboundACHTransferDeclineParams < Increase::Internal::Type::BaseModel # @return [Symbol, Increase::Models::InboundACHTransferDeclineParams::Reason, nil] optional :reason, enum: -> { Increase::Models::InboundACHTransferDeclineParams::Reason } - # @!parse - # # @return [Symbol, Increase::Models::InboundACHTransferDeclineParams::Reason] - # attr_writer :reason - - # @!parse - # # @param reason [Symbol, Increase::Models::InboundACHTransferDeclineParams::Reason] - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(reason: nil, request_options: {}, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(reason: nil, request_options: {}) + # @param reason [Symbol, Increase::Models::InboundACHTransferDeclineParams::Reason] + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] # The reason why this transfer will be returned. If this parameter is unset, the # return codes will be `payment_stopped` for debits and @@ -66,11 +57,8 @@ module Reason # The corporate customer no longer authorizes this transaction. The Nacha return code is R29. CORPORATE_CUSTOMER_ADVISED_NOT_AUTHORIZED = :corporate_customer_advised_not_authorized - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end diff --git a/lib/increase/models/inbound_ach_transfer_list_params.rb b/lib/increase/models/inbound_ach_transfer_list_params.rb index 75852d6fb..5d623655f 100644 --- a/lib/increase/models/inbound_ach_transfer_list_params.rb +++ b/lib/increase/models/inbound_ach_transfer_list_params.rb @@ -4,151 +4,91 @@ module Increase module Models # @see Increase::Resources::InboundACHTransfers#list class InboundACHTransferListParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters - # @!attribute [r] account_id + # @!attribute account_id # Filter Inbound ACH Transfers to ones belonging to the specified Account. # # @return [String, nil] optional :account_id, String - # @!parse - # # @return [String] - # attr_writer :account_id - - # @!attribute [r] account_number_id + # @!attribute account_number_id # Filter Inbound ACH Transfers to ones belonging to the specified Account Number. # # @return [String, nil] optional :account_number_id, String - # @!parse - # # @return [String] - # attr_writer :account_number_id - - # @!attribute [r] created_at + # @!attribute created_at # # @return [Increase::Models::InboundACHTransferListParams::CreatedAt, nil] optional :created_at, -> { Increase::Models::InboundACHTransferListParams::CreatedAt } - # @!parse - # # @return [Increase::Models::InboundACHTransferListParams::CreatedAt] - # attr_writer :created_at - - # @!attribute [r] cursor + # @!attribute cursor # Return the page of entries after this one. # # @return [String, nil] optional :cursor, String - # @!parse - # # @return [String] - # attr_writer :cursor - - # @!attribute [r] limit + # @!attribute limit # Limit the size of the list that is returned. The default (and maximum) is 100 # objects. # # @return [Integer, nil] optional :limit, Integer - # @!parse - # # @return [Integer] - # attr_writer :limit - - # @!attribute [r] status + # @!attribute status # # @return [Increase::Models::InboundACHTransferListParams::Status, nil] optional :status, -> { Increase::Models::InboundACHTransferListParams::Status } - # @!parse - # # @return [Increase::Models::InboundACHTransferListParams::Status] - # attr_writer :status - - # @!parse - # # @param account_id [String] - # # @param account_number_id [String] - # # @param created_at [Increase::Models::InboundACHTransferListParams::CreatedAt] - # # @param cursor [String] - # # @param limit [Integer] - # # @param status [Increase::Models::InboundACHTransferListParams::Status] - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize( - # account_id: nil, - # account_number_id: nil, - # created_at: nil, - # cursor: nil, - # limit: nil, - # status: nil, - # request_options: {}, - # ** - # ) - # super - # end - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(account_id: nil, account_number_id: nil, created_at: nil, cursor: nil, limit: nil, status: nil, request_options: {}) + # @param account_id [String] + # @param account_number_id [String] + # @param created_at [Increase::Models::InboundACHTransferListParams::CreatedAt] + # @param cursor [String] + # @param limit [Integer] + # @param status [Increase::Models::InboundACHTransferListParams::Status] + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] class CreatedAt < Increase::Internal::Type::BaseModel - # @!attribute [r] after + # @!attribute after # Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) # timestamp. # # @return [Time, nil] optional :after, Time - # @!parse - # # @return [Time] - # attr_writer :after - - # @!attribute [r] before + # @!attribute before # Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) # timestamp. # # @return [Time, nil] optional :before, Time - # @!parse - # # @return [Time] - # attr_writer :before - - # @!attribute [r] on_or_after + # @!attribute on_or_after # Return results on or after this # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. # # @return [Time, nil] optional :on_or_after, Time - # @!parse - # # @return [Time] - # attr_writer :on_or_after - - # @!attribute [r] on_or_before + # @!attribute on_or_before # Return results on or before this # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. # # @return [Time, nil] optional :on_or_before, Time - # @!parse - # # @return [Time] - # attr_writer :on_or_before - - # @!parse - # # @param after [Time] - # # @param before [Time] - # # @param on_or_after [Time] - # # @param on_or_before [Time] - # # - # def initialize(after: nil, before: nil, on_or_after: nil, on_or_before: nil, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(after: nil, before: nil, on_or_after: nil, on_or_before: nil) + # @param after [Time] + # @param before [Time] + # @param on_or_after [Time] + # @param on_or_before [Time] end class Status < Increase::Internal::Type::BaseModel - # @!attribute [r] in_ + # @!attribute in_ # Filter Inbound ACH Transfers to those with the specified status. For GET # requests, this should be encoded as a comma-delimited string, such as # `?in=one,two,three`. @@ -158,16 +98,8 @@ class Status < Increase::Internal::Type::BaseModel -> { Increase::Internal::Type::ArrayOf[enum: Increase::Models::InboundACHTransferListParams::Status::In] }, api_name: :in - # @!parse - # # @return [Array] - # attr_writer :in_ - - # @!parse - # # @param in_ [Array] - # # - # def initialize(in_: nil, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(in_: nil) + # @param in_ [Array] module In extend Increase::Internal::Type::Enum @@ -184,11 +116,8 @@ module In # The Inbound ACH Transfer has been returned. RETURNED = :returned - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end diff --git a/lib/increase/models/inbound_ach_transfer_retrieve_params.rb b/lib/increase/models/inbound_ach_transfer_retrieve_params.rb index 5d5e3b12b..fc3a572a9 100644 --- a/lib/increase/models/inbound_ach_transfer_retrieve_params.rb +++ b/lib/increase/models/inbound_ach_transfer_retrieve_params.rb @@ -4,16 +4,11 @@ module Increase module Models # @see Increase::Resources::InboundACHTransfers#retrieve class InboundACHTransferRetrieveParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters - # @!parse - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(request_options: {}, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(request_options: {}) + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/increase/models/inbound_ach_transfer_transfer_return_params.rb b/lib/increase/models/inbound_ach_transfer_transfer_return_params.rb index cabe4d502..440397bd3 100644 --- a/lib/increase/models/inbound_ach_transfer_transfer_return_params.rb +++ b/lib/increase/models/inbound_ach_transfer_transfer_return_params.rb @@ -4,8 +4,7 @@ module Increase module Models # @see Increase::Resources::InboundACHTransfers#transfer_return class InboundACHTransferTransferReturnParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters # @!attribute reason @@ -15,13 +14,9 @@ class InboundACHTransferTransferReturnParams < Increase::Internal::Type::BaseMod # @return [Symbol, Increase::Models::InboundACHTransferTransferReturnParams::Reason] required :reason, enum: -> { Increase::Models::InboundACHTransferTransferReturnParams::Reason } - # @!parse - # # @param reason [Symbol, Increase::Models::InboundACHTransferTransferReturnParams::Reason] - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(reason:, request_options: {}, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(reason:, request_options: {}) + # @param reason [Symbol, Increase::Models::InboundACHTransferTransferReturnParams::Reason] + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] # The reason why this transfer will be returned. The most usual return codes are # `payment_stopped` for debits and `credit_entry_refused_by_receiver` for credits. @@ -60,11 +55,8 @@ module Reason # The corporate customer no longer authorizes this transaction. The Nacha return code is R29. CORPORATE_CUSTOMER_ADVISED_NOT_AUTHORIZED = :corporate_customer_advised_not_authorized - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end diff --git a/lib/increase/models/inbound_check_deposit.rb b/lib/increase/models/inbound_check_deposit.rb index 981376b18..7e83ca698 100644 --- a/lib/increase/models/inbound_check_deposit.rb +++ b/lib/increase/models/inbound_check_deposit.rb @@ -139,58 +139,30 @@ class InboundCheckDeposit < Increase::Internal::Type::BaseModel # @return [Symbol, Increase::Models::InboundCheckDeposit::Type] required :type, enum: -> { Increase::Models::InboundCheckDeposit::Type } - # @!parse - # # Inbound Check Deposits are records of third-parties attempting to deposit checks - # # against your account. - # # - # # @param id [String] - # # @param accepted_at [Time, nil] - # # @param account_id [String] - # # @param account_number_id [String, nil] - # # @param adjustments [Array] - # # @param amount [Integer] - # # @param back_image_file_id [String, nil] - # # @param bank_of_first_deposit_routing_number [String, nil] - # # @param check_number [String, nil] - # # @param check_transfer_id [String, nil] - # # @param created_at [Time] - # # @param currency [Symbol, Increase::Models::InboundCheckDeposit::Currency] - # # @param declined_at [Time, nil] - # # @param declined_transaction_id [String, nil] - # # @param deposit_return [Increase::Models::InboundCheckDeposit::DepositReturn, nil] - # # @param front_image_file_id [String, nil] - # # @param payee_name_analysis [Symbol, Increase::Models::InboundCheckDeposit::PayeeNameAnalysis] - # # @param status [Symbol, Increase::Models::InboundCheckDeposit::Status] - # # @param transaction_id [String, nil] - # # @param type [Symbol, Increase::Models::InboundCheckDeposit::Type] - # # - # def initialize( - # id:, - # accepted_at:, - # account_id:, - # account_number_id:, - # adjustments:, - # amount:, - # back_image_file_id:, - # bank_of_first_deposit_routing_number:, - # check_number:, - # check_transfer_id:, - # created_at:, - # currency:, - # declined_at:, - # declined_transaction_id:, - # deposit_return:, - # front_image_file_id:, - # payee_name_analysis:, - # status:, - # transaction_id:, - # type:, - # ** - # ) - # super - # end - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(id:, accepted_at:, account_id:, account_number_id:, adjustments:, amount:, back_image_file_id:, bank_of_first_deposit_routing_number:, check_number:, check_transfer_id:, created_at:, currency:, declined_at:, declined_transaction_id:, deposit_return:, front_image_file_id:, payee_name_analysis:, status:, transaction_id:, type:) + # Inbound Check Deposits are records of third-parties attempting to deposit checks + # against your account. + # + # @param id [String] + # @param accepted_at [Time, nil] + # @param account_id [String] + # @param account_number_id [String, nil] + # @param adjustments [Array] + # @param amount [Integer] + # @param back_image_file_id [String, nil] + # @param bank_of_first_deposit_routing_number [String, nil] + # @param check_number [String, nil] + # @param check_transfer_id [String, nil] + # @param created_at [Time] + # @param currency [Symbol, Increase::Models::InboundCheckDeposit::Currency] + # @param declined_at [Time, nil] + # @param declined_transaction_id [String, nil] + # @param deposit_return [Increase::Models::InboundCheckDeposit::DepositReturn, nil] + # @param front_image_file_id [String, nil] + # @param payee_name_analysis [Symbol, Increase::Models::InboundCheckDeposit::PayeeNameAnalysis] + # @param status [Symbol, Increase::Models::InboundCheckDeposit::Status] + # @param transaction_id [String, nil] + # @param type [Symbol, Increase::Models::InboundCheckDeposit::Type] class Adjustment < Increase::Internal::Type::BaseModel # @!attribute adjusted_at @@ -217,15 +189,11 @@ class Adjustment < Increase::Internal::Type::BaseModel # @return [String] required :transaction_id, String - # @!parse - # # @param adjusted_at [Time] - # # @param amount [Integer] - # # @param reason [Symbol, Increase::Models::InboundCheckDeposit::Adjustment::Reason] - # # @param transaction_id [String] - # # - # def initialize(adjusted_at:, amount:, reason:, transaction_id:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(adjusted_at:, amount:, reason:, transaction_id:) + # @param adjusted_at [Time] + # @param amount [Integer] + # @param reason [Symbol, Increase::Models::InboundCheckDeposit::Adjustment::Reason] + # @param transaction_id [String] # The reason for the adjustment. # @@ -245,11 +213,8 @@ module Reason # The recipient was not able to process the check. This usually happens for e.g., low quality images. NON_CONFORMING_ITEM = :non_conforming_item - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -277,11 +242,8 @@ module Currency # US Dollar (USD) USD = :USD - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Increase::Models::InboundCheckDeposit#deposit_return @@ -304,17 +266,13 @@ class DepositReturn < Increase::Internal::Type::BaseModel # @return [String] required :transaction_id, String - # @!parse - # # If you requested a return of this deposit, this will contain details of the - # # return. - # # - # # @param reason [Symbol, Increase::Models::InboundCheckDeposit::DepositReturn::Reason] - # # @param returned_at [Time] - # # @param transaction_id [String] - # # - # def initialize(reason:, returned_at:, transaction_id:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(reason:, returned_at:, transaction_id:) + # If you requested a return of this deposit, this will contain details of the + # return. + # + # @param reason [Symbol, Increase::Models::InboundCheckDeposit::DepositReturn::Reason] + # @param returned_at [Time] + # @param transaction_id [String] # The reason the deposit was returned. # @@ -337,11 +295,8 @@ module Reason # The check was not endorsed by the payee. ENDORSEMENT_IRREGULAR = :endorsement_irregular - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -361,11 +316,8 @@ module PayeeNameAnalysis # The payee name analysis was not evaluated. NOT_EVALUATED = :not_evaluated - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # The status of the Inbound Check Deposit. @@ -389,11 +341,8 @@ module Status # The Inbound Check Deposit requires attention from an Increase operator. REQUIRES_ATTENTION = :requires_attention - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # A constant representing the object's type. For this resource it will always be @@ -405,11 +354,8 @@ module Type INBOUND_CHECK_DEPOSIT = :inbound_check_deposit - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end diff --git a/lib/increase/models/inbound_check_deposit_decline_params.rb b/lib/increase/models/inbound_check_deposit_decline_params.rb index 9c6f744f8..683f2bf8d 100644 --- a/lib/increase/models/inbound_check_deposit_decline_params.rb +++ b/lib/increase/models/inbound_check_deposit_decline_params.rb @@ -4,16 +4,11 @@ module Increase module Models # @see Increase::Resources::InboundCheckDeposits#decline class InboundCheckDepositDeclineParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters - # @!parse - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(request_options: {}, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(request_options: {}) + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/increase/models/inbound_check_deposit_list_params.rb b/lib/increase/models/inbound_check_deposit_list_params.rb index 6b501f8c0..737a68d23 100644 --- a/lib/increase/models/inbound_check_deposit_list_params.rb +++ b/lib/increase/models/inbound_check_deposit_list_params.rb @@ -4,127 +4,82 @@ module Increase module Models # @see Increase::Resources::InboundCheckDeposits#list class InboundCheckDepositListParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters - # @!attribute [r] account_id + # @!attribute account_id # Filter Inbound Check Deposits to those belonging to the specified Account. # # @return [String, nil] optional :account_id, String - # @!parse - # # @return [String] - # attr_writer :account_id - - # @!attribute [r] check_transfer_id + # @!attribute check_transfer_id # Filter Inbound Check Deposits to those belonging to the specified Check # Transfer. # # @return [String, nil] optional :check_transfer_id, String - # @!parse - # # @return [String] - # attr_writer :check_transfer_id - - # @!attribute [r] created_at + # @!attribute created_at # # @return [Increase::Models::InboundCheckDepositListParams::CreatedAt, nil] optional :created_at, -> { Increase::Models::InboundCheckDepositListParams::CreatedAt } - # @!parse - # # @return [Increase::Models::InboundCheckDepositListParams::CreatedAt] - # attr_writer :created_at - - # @!attribute [r] cursor + # @!attribute cursor # Return the page of entries after this one. # # @return [String, nil] optional :cursor, String - # @!parse - # # @return [String] - # attr_writer :cursor - - # @!attribute [r] limit + # @!attribute limit # Limit the size of the list that is returned. The default (and maximum) is 100 # objects. # # @return [Integer, nil] optional :limit, Integer - # @!parse - # # @return [Integer] - # attr_writer :limit - - # @!parse - # # @param account_id [String] - # # @param check_transfer_id [String] - # # @param created_at [Increase::Models::InboundCheckDepositListParams::CreatedAt] - # # @param cursor [String] - # # @param limit [Integer] - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(account_id: nil, check_transfer_id: nil, created_at: nil, cursor: nil, limit: nil, request_options: {}, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(account_id: nil, check_transfer_id: nil, created_at: nil, cursor: nil, limit: nil, request_options: {}) + # @param account_id [String] + # @param check_transfer_id [String] + # @param created_at [Increase::Models::InboundCheckDepositListParams::CreatedAt] + # @param cursor [String] + # @param limit [Integer] + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] class CreatedAt < Increase::Internal::Type::BaseModel - # @!attribute [r] after + # @!attribute after # Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) # timestamp. # # @return [Time, nil] optional :after, Time - # @!parse - # # @return [Time] - # attr_writer :after - - # @!attribute [r] before + # @!attribute before # Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) # timestamp. # # @return [Time, nil] optional :before, Time - # @!parse - # # @return [Time] - # attr_writer :before - - # @!attribute [r] on_or_after + # @!attribute on_or_after # Return results on or after this # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. # # @return [Time, nil] optional :on_or_after, Time - # @!parse - # # @return [Time] - # attr_writer :on_or_after - - # @!attribute [r] on_or_before + # @!attribute on_or_before # Return results on or before this # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. # # @return [Time, nil] optional :on_or_before, Time - # @!parse - # # @return [Time] - # attr_writer :on_or_before - - # @!parse - # # @param after [Time] - # # @param before [Time] - # # @param on_or_after [Time] - # # @param on_or_before [Time] - # # - # def initialize(after: nil, before: nil, on_or_after: nil, on_or_before: nil, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(after: nil, before: nil, on_or_after: nil, on_or_before: nil) + # @param after [Time] + # @param before [Time] + # @param on_or_after [Time] + # @param on_or_before [Time] end end end diff --git a/lib/increase/models/inbound_check_deposit_retrieve_params.rb b/lib/increase/models/inbound_check_deposit_retrieve_params.rb index 9407a42e8..ff9c3a348 100644 --- a/lib/increase/models/inbound_check_deposit_retrieve_params.rb +++ b/lib/increase/models/inbound_check_deposit_retrieve_params.rb @@ -4,16 +4,11 @@ module Increase module Models # @see Increase::Resources::InboundCheckDeposits#retrieve class InboundCheckDepositRetrieveParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters - # @!parse - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(request_options: {}, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(request_options: {}) + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/increase/models/inbound_check_deposit_return_params.rb b/lib/increase/models/inbound_check_deposit_return_params.rb index e186e5a99..524870b0b 100644 --- a/lib/increase/models/inbound_check_deposit_return_params.rb +++ b/lib/increase/models/inbound_check_deposit_return_params.rb @@ -4,8 +4,7 @@ module Increase module Models # @see Increase::Resources::InboundCheckDeposits#return_ class InboundCheckDepositReturnParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters # @!attribute reason @@ -14,13 +13,9 @@ class InboundCheckDepositReturnParams < Increase::Internal::Type::BaseModel # @return [Symbol, Increase::Models::InboundCheckDepositReturnParams::Reason] required :reason, enum: -> { Increase::Models::InboundCheckDepositReturnParams::Reason } - # @!parse - # # @param reason [Symbol, Increase::Models::InboundCheckDepositReturnParams::Reason] - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(reason:, request_options: {}, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(reason:, request_options: {}) + # @param reason [Symbol, Increase::Models::InboundCheckDepositReturnParams::Reason] + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] # The reason to return the Inbound Check Deposit. module Reason @@ -41,11 +36,8 @@ module Reason # The check was not endorsed by the payee. ENDORSEMENT_IRREGULAR = :endorsement_irregular - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end diff --git a/lib/increase/models/inbound_mail_item.rb b/lib/increase/models/inbound_mail_item.rb index f3477bbb5..14b08fcc5 100644 --- a/lib/increase/models/inbound_mail_item.rb +++ b/lib/increase/models/inbound_mail_item.rb @@ -55,21 +55,17 @@ class InboundMailItem < Increase::Internal::Type::BaseModel # @return [Symbol, Increase::Models::InboundMailItem::Type] required :type, enum: -> { Increase::Models::InboundMailItem::Type } - # @!parse - # # Inbound Mail Items represent pieces of physical mail delivered to a Lockbox. - # # - # # @param id [String] - # # @param created_at [Time] - # # @param file_id [String] - # # @param lockbox_id [String, nil] - # # @param recipient_name [String, nil] - # # @param rejection_reason [Symbol, Increase::Models::InboundMailItem::RejectionReason, nil] - # # @param status [Symbol, Increase::Models::InboundMailItem::Status] - # # @param type [Symbol, Increase::Models::InboundMailItem::Type] - # # - # def initialize(id:, created_at:, file_id:, lockbox_id:, recipient_name:, rejection_reason:, status:, type:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(id:, created_at:, file_id:, lockbox_id:, recipient_name:, rejection_reason:, status:, type:) + # Inbound Mail Items represent pieces of physical mail delivered to a Lockbox. + # + # @param id [String] + # @param created_at [Time] + # @param file_id [String] + # @param lockbox_id [String, nil] + # @param recipient_name [String, nil] + # @param rejection_reason [Symbol, Increase::Models::InboundMailItem::RejectionReason, nil] + # @param status [Symbol, Increase::Models::InboundMailItem::Status] + # @param type [Symbol, Increase::Models::InboundMailItem::Type] # If the mail item has been rejected, why it was rejected. # @@ -86,11 +82,8 @@ module RejectionReason # The Lockbox or its associated Account is not active. LOCKBOX_NOT_ACTIVE = :lockbox_not_active - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # If the mail item has been processed. @@ -108,11 +101,8 @@ module Status # The mail item has been rejected. REJECTED = :rejected - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # A constant representing the object's type. For this resource it will always be @@ -124,11 +114,8 @@ module Type INBOUND_MAIL_ITEM = :inbound_mail_item - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end diff --git a/lib/increase/models/inbound_mail_item_list_params.rb b/lib/increase/models/inbound_mail_item_list_params.rb index 49dd358fe..badf23785 100644 --- a/lib/increase/models/inbound_mail_item_list_params.rb +++ b/lib/increase/models/inbound_mail_item_list_params.rb @@ -4,115 +4,74 @@ module Increase module Models # @see Increase::Resources::InboundMailItems#list class InboundMailItemListParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters - # @!attribute [r] created_at + # @!attribute created_at # # @return [Increase::Models::InboundMailItemListParams::CreatedAt, nil] optional :created_at, -> { Increase::Models::InboundMailItemListParams::CreatedAt } - # @!parse - # # @return [Increase::Models::InboundMailItemListParams::CreatedAt] - # attr_writer :created_at - - # @!attribute [r] cursor + # @!attribute cursor # Return the page of entries after this one. # # @return [String, nil] optional :cursor, String - # @!parse - # # @return [String] - # attr_writer :cursor - - # @!attribute [r] limit + # @!attribute limit # Limit the size of the list that is returned. The default (and maximum) is 100 # objects. # # @return [Integer, nil] optional :limit, Integer - # @!parse - # # @return [Integer] - # attr_writer :limit - - # @!attribute [r] lockbox_id + # @!attribute lockbox_id # Filter Inbound Mail Items to ones sent to the provided Lockbox. # # @return [String, nil] optional :lockbox_id, String - # @!parse - # # @return [String] - # attr_writer :lockbox_id - - # @!parse - # # @param created_at [Increase::Models::InboundMailItemListParams::CreatedAt] - # # @param cursor [String] - # # @param limit [Integer] - # # @param lockbox_id [String] - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(created_at: nil, cursor: nil, limit: nil, lockbox_id: nil, request_options: {}, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(created_at: nil, cursor: nil, limit: nil, lockbox_id: nil, request_options: {}) + # @param created_at [Increase::Models::InboundMailItemListParams::CreatedAt] + # @param cursor [String] + # @param limit [Integer] + # @param lockbox_id [String] + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] class CreatedAt < Increase::Internal::Type::BaseModel - # @!attribute [r] after + # @!attribute after # Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) # timestamp. # # @return [Time, nil] optional :after, Time - # @!parse - # # @return [Time] - # attr_writer :after - - # @!attribute [r] before + # @!attribute before # Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) # timestamp. # # @return [Time, nil] optional :before, Time - # @!parse - # # @return [Time] - # attr_writer :before - - # @!attribute [r] on_or_after + # @!attribute on_or_after # Return results on or after this # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. # # @return [Time, nil] optional :on_or_after, Time - # @!parse - # # @return [Time] - # attr_writer :on_or_after - - # @!attribute [r] on_or_before + # @!attribute on_or_before # Return results on or before this # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. # # @return [Time, nil] optional :on_or_before, Time - # @!parse - # # @return [Time] - # attr_writer :on_or_before - - # @!parse - # # @param after [Time] - # # @param before [Time] - # # @param on_or_after [Time] - # # @param on_or_before [Time] - # # - # def initialize(after: nil, before: nil, on_or_after: nil, on_or_before: nil, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(after: nil, before: nil, on_or_after: nil, on_or_before: nil) + # @param after [Time] + # @param before [Time] + # @param on_or_after [Time] + # @param on_or_before [Time] end end end diff --git a/lib/increase/models/inbound_mail_item_retrieve_params.rb b/lib/increase/models/inbound_mail_item_retrieve_params.rb index 95526e490..8f64571d8 100644 --- a/lib/increase/models/inbound_mail_item_retrieve_params.rb +++ b/lib/increase/models/inbound_mail_item_retrieve_params.rb @@ -4,16 +4,11 @@ module Increase module Models # @see Increase::Resources::InboundMailItems#retrieve class InboundMailItemRetrieveParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters - # @!parse - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(request_options: {}, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(request_options: {}) + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/increase/models/inbound_real_time_payments_transfer.rb b/lib/increase/models/inbound_real_time_payments_transfer.rb index 382325062..c9fd01277 100755 --- a/lib/increase/models/inbound_real_time_payments_transfer.rb +++ b/lib/increase/models/inbound_real_time_payments_transfer.rb @@ -103,50 +103,26 @@ class InboundRealTimePaymentsTransfer < Increase::Internal::Type::BaseModel # @return [Symbol, Increase::Models::InboundRealTimePaymentsTransfer::Type] required :type, enum: -> { Increase::Models::InboundRealTimePaymentsTransfer::Type } - # @!parse - # # An Inbound Real-Time Payments Transfer is a Real-Time Payments transfer - # # initiated outside of Increase to your account. - # # - # # @param id [String] - # # @param account_id [String] - # # @param account_number_id [String] - # # @param amount [Integer] - # # @param confirmation [Increase::Models::InboundRealTimePaymentsTransfer::Confirmation, nil] - # # @param created_at [Time] - # # @param creditor_name [String] - # # @param currency [Symbol, Increase::Models::InboundRealTimePaymentsTransfer::Currency] - # # @param debtor_account_number [String] - # # @param debtor_name [String] - # # @param debtor_routing_number [String] - # # @param decline [Increase::Models::InboundRealTimePaymentsTransfer::Decline, nil] - # # @param remittance_information [String, nil] - # # @param status [Symbol, Increase::Models::InboundRealTimePaymentsTransfer::Status] - # # @param transaction_identification [String] - # # @param type [Symbol, Increase::Models::InboundRealTimePaymentsTransfer::Type] - # # - # def initialize( - # id:, - # account_id:, - # account_number_id:, - # amount:, - # confirmation:, - # created_at:, - # creditor_name:, - # currency:, - # debtor_account_number:, - # debtor_name:, - # debtor_routing_number:, - # decline:, - # remittance_information:, - # status:, - # transaction_identification:, - # type:, - # ** - # ) - # super - # end - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(id:, account_id:, account_number_id:, amount:, confirmation:, created_at:, creditor_name:, currency:, debtor_account_number:, debtor_name:, debtor_routing_number:, decline:, remittance_information:, status:, transaction_identification:, type:) + # An Inbound Real-Time Payments Transfer is a Real-Time Payments transfer + # initiated outside of Increase to your account. + # + # @param id [String] + # @param account_id [String] + # @param account_number_id [String] + # @param amount [Integer] + # @param confirmation [Increase::Models::InboundRealTimePaymentsTransfer::Confirmation, nil] + # @param created_at [Time] + # @param creditor_name [String] + # @param currency [Symbol, Increase::Models::InboundRealTimePaymentsTransfer::Currency] + # @param debtor_account_number [String] + # @param debtor_name [String] + # @param debtor_routing_number [String] + # @param decline [Increase::Models::InboundRealTimePaymentsTransfer::Decline, nil] + # @param remittance_information [String, nil] + # @param status [Symbol, Increase::Models::InboundRealTimePaymentsTransfer::Status] + # @param transaction_identification [String] + # @param type [Symbol, Increase::Models::InboundRealTimePaymentsTransfer::Type] # @see Increase::Models::InboundRealTimePaymentsTransfer#confirmation class Confirmation < Increase::Internal::Type::BaseModel @@ -162,15 +138,11 @@ class Confirmation < Increase::Internal::Type::BaseModel # @return [String] required :transaction_id, String - # @!parse - # # If your transfer is confirmed, this will contain details of the confirmation. - # # - # # @param confirmed_at [Time] - # # @param transaction_id [String] - # # - # def initialize(confirmed_at:, transaction_id:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(confirmed_at:, transaction_id:) + # If your transfer is confirmed, this will contain details of the confirmation. + # + # @param confirmed_at [Time] + # @param transaction_id [String] end # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code of the transfer's @@ -198,11 +170,8 @@ module Currency # US Dollar (USD) USD = :USD - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Increase::Models::InboundRealTimePaymentsTransfer#decline @@ -225,16 +194,12 @@ class Decline < Increase::Internal::Type::BaseModel # @return [Symbol, Increase::Models::InboundRealTimePaymentsTransfer::Decline::Reason] required :reason, enum: -> { Increase::Models::InboundRealTimePaymentsTransfer::Decline::Reason } - # @!parse - # # If your transfer is declined, this will contain details of the decline. - # # - # # @param declined_at [Time] - # # @param declined_transaction_id [String] - # # @param reason [Symbol, Increase::Models::InboundRealTimePaymentsTransfer::Decline::Reason] - # # - # def initialize(declined_at:, declined_transaction_id:, reason:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(declined_at:, declined_transaction_id:, reason:) + # If your transfer is declined, this will contain details of the decline. + # + # @param declined_at [Time] + # @param declined_transaction_id [String] + # @param reason [Symbol, Increase::Models::InboundRealTimePaymentsTransfer::Decline::Reason] # The reason for the transfer decline. # @@ -260,11 +225,8 @@ module Reason # Your account is not enabled to receive Real-Time Payments transfers. REAL_TIME_PAYMENTS_NOT_ENABLED = :real_time_payments_not_enabled - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -286,11 +248,8 @@ module Status # The transfer has been declined. DECLINED = :declined - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # A constant representing the object's type. For this resource it will always be @@ -302,11 +261,8 @@ module Type INBOUND_REAL_TIME_PAYMENTS_TRANSFER = :inbound_real_time_payments_transfer - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end diff --git a/lib/increase/models/inbound_real_time_payments_transfer_list_params.rb b/lib/increase/models/inbound_real_time_payments_transfer_list_params.rb index c63c152f4..8de9120a7 100644 --- a/lib/increase/models/inbound_real_time_payments_transfer_list_params.rb +++ b/lib/increase/models/inbound_real_time_payments_transfer_list_params.rb @@ -4,128 +4,83 @@ module Increase module Models # @see Increase::Resources::InboundRealTimePaymentsTransfers#list class InboundRealTimePaymentsTransferListParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters - # @!attribute [r] account_id + # @!attribute account_id # Filter Inbound Real-Time Payments Transfers to those belonging to the specified # Account. # # @return [String, nil] optional :account_id, String - # @!parse - # # @return [String] - # attr_writer :account_id - - # @!attribute [r] account_number_id + # @!attribute account_number_id # Filter Inbound Real-Time Payments Transfers to ones belonging to the specified # Account Number. # # @return [String, nil] optional :account_number_id, String - # @!parse - # # @return [String] - # attr_writer :account_number_id - - # @!attribute [r] created_at + # @!attribute created_at # # @return [Increase::Models::InboundRealTimePaymentsTransferListParams::CreatedAt, nil] optional :created_at, -> { Increase::Models::InboundRealTimePaymentsTransferListParams::CreatedAt } - # @!parse - # # @return [Increase::Models::InboundRealTimePaymentsTransferListParams::CreatedAt] - # attr_writer :created_at - - # @!attribute [r] cursor + # @!attribute cursor # Return the page of entries after this one. # # @return [String, nil] optional :cursor, String - # @!parse - # # @return [String] - # attr_writer :cursor - - # @!attribute [r] limit + # @!attribute limit # Limit the size of the list that is returned. The default (and maximum) is 100 # objects. # # @return [Integer, nil] optional :limit, Integer - # @!parse - # # @return [Integer] - # attr_writer :limit - - # @!parse - # # @param account_id [String] - # # @param account_number_id [String] - # # @param created_at [Increase::Models::InboundRealTimePaymentsTransferListParams::CreatedAt] - # # @param cursor [String] - # # @param limit [Integer] - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(account_id: nil, account_number_id: nil, created_at: nil, cursor: nil, limit: nil, request_options: {}, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(account_id: nil, account_number_id: nil, created_at: nil, cursor: nil, limit: nil, request_options: {}) + # @param account_id [String] + # @param account_number_id [String] + # @param created_at [Increase::Models::InboundRealTimePaymentsTransferListParams::CreatedAt] + # @param cursor [String] + # @param limit [Integer] + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] class CreatedAt < Increase::Internal::Type::BaseModel - # @!attribute [r] after + # @!attribute after # Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) # timestamp. # # @return [Time, nil] optional :after, Time - # @!parse - # # @return [Time] - # attr_writer :after - - # @!attribute [r] before + # @!attribute before # Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) # timestamp. # # @return [Time, nil] optional :before, Time - # @!parse - # # @return [Time] - # attr_writer :before - - # @!attribute [r] on_or_after + # @!attribute on_or_after # Return results on or after this # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. # # @return [Time, nil] optional :on_or_after, Time - # @!parse - # # @return [Time] - # attr_writer :on_or_after - - # @!attribute [r] on_or_before + # @!attribute on_or_before # Return results on or before this # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. # # @return [Time, nil] optional :on_or_before, Time - # @!parse - # # @return [Time] - # attr_writer :on_or_before - - # @!parse - # # @param after [Time] - # # @param before [Time] - # # @param on_or_after [Time] - # # @param on_or_before [Time] - # # - # def initialize(after: nil, before: nil, on_or_after: nil, on_or_before: nil, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(after: nil, before: nil, on_or_after: nil, on_or_before: nil) + # @param after [Time] + # @param before [Time] + # @param on_or_after [Time] + # @param on_or_before [Time] end end end diff --git a/lib/increase/models/inbound_real_time_payments_transfer_retrieve_params.rb b/lib/increase/models/inbound_real_time_payments_transfer_retrieve_params.rb index 93a7452f7..ff1eca21c 100644 --- a/lib/increase/models/inbound_real_time_payments_transfer_retrieve_params.rb +++ b/lib/increase/models/inbound_real_time_payments_transfer_retrieve_params.rb @@ -4,16 +4,11 @@ module Increase module Models # @see Increase::Resources::InboundRealTimePaymentsTransfers#retrieve class InboundRealTimePaymentsTransferRetrieveParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters - # @!parse - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(request_options: {}, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(request_options: {}) + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/increase/models/inbound_wire_drawdown_request.rb b/lib/increase/models/inbound_wire_drawdown_request.rb index 3e559a241..7c7917f97 100644 --- a/lib/increase/models/inbound_wire_drawdown_request.rb +++ b/lib/increase/models/inbound_wire_drawdown_request.rb @@ -75,8 +75,8 @@ class InboundWireDrawdownRequest < Increase::Internal::Type::BaseModel # @!attribute originator_account_number # The drawdown request's originator's account number. # - # @return [String] - required :originator_account_number, String + # @return [String, nil] + required :originator_account_number, String, nil?: true # @!attribute originator_address_line1 # Line 1 of the drawdown request's originator's address. @@ -150,65 +150,34 @@ class InboundWireDrawdownRequest < Increase::Internal::Type::BaseModel # @return [Symbol, Increase::Models::InboundWireDrawdownRequest::Type] required :type, enum: -> { Increase::Models::InboundWireDrawdownRequest::Type } - # @!parse - # # Inbound wire drawdown requests are requests from someone else to send them a - # # wire. This feature is in beta; reach out to - # # [support@increase.com](mailto:support@increase.com) to learn more. - # # - # # @param id [String] - # # @param amount [Integer] - # # @param beneficiary_account_number [String] - # # @param beneficiary_address_line1 [String, nil] - # # @param beneficiary_address_line2 [String, nil] - # # @param beneficiary_address_line3 [String, nil] - # # @param beneficiary_name [String, nil] - # # @param beneficiary_routing_number [String] - # # @param created_at [Time] - # # @param currency [String] - # # @param message_to_recipient [String, nil] - # # @param originator_account_number [String] - # # @param originator_address_line1 [String, nil] - # # @param originator_address_line2 [String, nil] - # # @param originator_address_line3 [String, nil] - # # @param originator_name [String, nil] - # # @param originator_routing_number [String] - # # @param originator_to_beneficiary_information_line1 [String, nil] - # # @param originator_to_beneficiary_information_line2 [String, nil] - # # @param originator_to_beneficiary_information_line3 [String, nil] - # # @param originator_to_beneficiary_information_line4 [String, nil] - # # @param recipient_account_number_id [String] - # # @param type [Symbol, Increase::Models::InboundWireDrawdownRequest::Type] - # # - # def initialize( - # id:, - # amount:, - # beneficiary_account_number:, - # beneficiary_address_line1:, - # beneficiary_address_line2:, - # beneficiary_address_line3:, - # beneficiary_name:, - # beneficiary_routing_number:, - # created_at:, - # currency:, - # message_to_recipient:, - # originator_account_number:, - # originator_address_line1:, - # originator_address_line2:, - # originator_address_line3:, - # originator_name:, - # originator_routing_number:, - # originator_to_beneficiary_information_line1:, - # originator_to_beneficiary_information_line2:, - # originator_to_beneficiary_information_line3:, - # originator_to_beneficiary_information_line4:, - # recipient_account_number_id:, - # type:, - # ** - # ) - # super - # end - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(id:, amount:, beneficiary_account_number:, beneficiary_address_line1:, beneficiary_address_line2:, beneficiary_address_line3:, beneficiary_name:, beneficiary_routing_number:, created_at:, currency:, message_to_recipient:, originator_account_number:, originator_address_line1:, originator_address_line2:, originator_address_line3:, originator_name:, originator_routing_number:, originator_to_beneficiary_information_line1:, originator_to_beneficiary_information_line2:, originator_to_beneficiary_information_line3:, originator_to_beneficiary_information_line4:, recipient_account_number_id:, type:) + # Inbound wire drawdown requests are requests from someone else to send them a + # wire. This feature is in beta; reach out to + # [support@increase.com](mailto:support@increase.com) to learn more. + # + # @param id [String] + # @param amount [Integer] + # @param beneficiary_account_number [String] + # @param beneficiary_address_line1 [String, nil] + # @param beneficiary_address_line2 [String, nil] + # @param beneficiary_address_line3 [String, nil] + # @param beneficiary_name [String, nil] + # @param beneficiary_routing_number [String] + # @param created_at [Time] + # @param currency [String] + # @param message_to_recipient [String, nil] + # @param originator_account_number [String, nil] + # @param originator_address_line1 [String, nil] + # @param originator_address_line2 [String, nil] + # @param originator_address_line3 [String, nil] + # @param originator_name [String, nil] + # @param originator_routing_number [String] + # @param originator_to_beneficiary_information_line1 [String, nil] + # @param originator_to_beneficiary_information_line2 [String, nil] + # @param originator_to_beneficiary_information_line3 [String, nil] + # @param originator_to_beneficiary_information_line4 [String, nil] + # @param recipient_account_number_id [String] + # @param type [Symbol, Increase::Models::InboundWireDrawdownRequest::Type] # A constant representing the object's type. For this resource it will always be # `inbound_wire_drawdown_request`. @@ -219,11 +188,8 @@ module Type INBOUND_WIRE_DRAWDOWN_REQUEST = :inbound_wire_drawdown_request - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end diff --git a/lib/increase/models/inbound_wire_drawdown_request_list_params.rb b/lib/increase/models/inbound_wire_drawdown_request_list_params.rb index 44211ee34..bb0d1c8cc 100644 --- a/lib/increase/models/inbound_wire_drawdown_request_list_params.rb +++ b/lib/increase/models/inbound_wire_drawdown_request_list_params.rb @@ -4,39 +4,26 @@ module Increase module Models # @see Increase::Resources::InboundWireDrawdownRequests#list class InboundWireDrawdownRequestListParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters - # @!attribute [r] cursor + # @!attribute cursor # Return the page of entries after this one. # # @return [String, nil] optional :cursor, String - # @!parse - # # @return [String] - # attr_writer :cursor - - # @!attribute [r] limit + # @!attribute limit # Limit the size of the list that is returned. The default (and maximum) is 100 # objects. # # @return [Integer, nil] optional :limit, Integer - # @!parse - # # @return [Integer] - # attr_writer :limit - - # @!parse - # # @param cursor [String] - # # @param limit [Integer] - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(cursor: nil, limit: nil, request_options: {}, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(cursor: nil, limit: nil, request_options: {}) + # @param cursor [String] + # @param limit [Integer] + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/increase/models/inbound_wire_drawdown_request_retrieve_params.rb b/lib/increase/models/inbound_wire_drawdown_request_retrieve_params.rb index 1da3318e2..6a23068ba 100644 --- a/lib/increase/models/inbound_wire_drawdown_request_retrieve_params.rb +++ b/lib/increase/models/inbound_wire_drawdown_request_retrieve_params.rb @@ -4,16 +4,11 @@ module Increase module Models # @see Increase::Resources::InboundWireDrawdownRequests#retrieve class InboundWireDrawdownRequestRetrieveParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters - # @!parse - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(request_options: {}, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(request_options: {}) + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/increase/models/inbound_wire_transfer.rb b/lib/increase/models/inbound_wire_transfer.rb index c799967d3..62188a7aa 100644 --- a/lib/increase/models/inbound_wire_transfer.rb +++ b/lib/increase/models/inbound_wire_transfer.rb @@ -159,68 +159,35 @@ class InboundWireTransfer < Increase::Internal::Type::BaseModel # @return [Symbol, Increase::Models::InboundWireTransfer::Type] required :type, enum: -> { Increase::Models::InboundWireTransfer::Type } - # @!parse - # # An Inbound Wire Transfer is a wire transfer initiated outside of Increase to - # # your account. - # # - # # @param id [String] - # # @param account_id [String] - # # @param account_number_id [String] - # # @param amount [Integer] - # # @param beneficiary_address_line1 [String, nil] - # # @param beneficiary_address_line2 [String, nil] - # # @param beneficiary_address_line3 [String, nil] - # # @param beneficiary_name [String, nil] - # # @param beneficiary_reference [String, nil] - # # @param created_at [Time] - # # @param description [String] - # # @param input_message_accountability_data [String, nil] - # # @param originator_address_line1 [String, nil] - # # @param originator_address_line2 [String, nil] - # # @param originator_address_line3 [String, nil] - # # @param originator_name [String, nil] - # # @param originator_routing_number [String, nil] - # # @param originator_to_beneficiary_information [String, nil] - # # @param originator_to_beneficiary_information_line1 [String, nil] - # # @param originator_to_beneficiary_information_line2 [String, nil] - # # @param originator_to_beneficiary_information_line3 [String, nil] - # # @param originator_to_beneficiary_information_line4 [String, nil] - # # @param sender_reference [String, nil] - # # @param status [Symbol, Increase::Models::InboundWireTransfer::Status] - # # @param type [Symbol, Increase::Models::InboundWireTransfer::Type] - # # - # def initialize( - # id:, - # account_id:, - # account_number_id:, - # amount:, - # beneficiary_address_line1:, - # beneficiary_address_line2:, - # beneficiary_address_line3:, - # beneficiary_name:, - # beneficiary_reference:, - # created_at:, - # description:, - # input_message_accountability_data:, - # originator_address_line1:, - # originator_address_line2:, - # originator_address_line3:, - # originator_name:, - # originator_routing_number:, - # originator_to_beneficiary_information:, - # originator_to_beneficiary_information_line1:, - # originator_to_beneficiary_information_line2:, - # originator_to_beneficiary_information_line3:, - # originator_to_beneficiary_information_line4:, - # sender_reference:, - # status:, - # type:, - # ** - # ) - # super - # end - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(id:, account_id:, account_number_id:, amount:, beneficiary_address_line1:, beneficiary_address_line2:, beneficiary_address_line3:, beneficiary_name:, beneficiary_reference:, created_at:, description:, input_message_accountability_data:, originator_address_line1:, originator_address_line2:, originator_address_line3:, originator_name:, originator_routing_number:, originator_to_beneficiary_information:, originator_to_beneficiary_information_line1:, originator_to_beneficiary_information_line2:, originator_to_beneficiary_information_line3:, originator_to_beneficiary_information_line4:, sender_reference:, status:, type:) + # An Inbound Wire Transfer is a wire transfer initiated outside of Increase to + # your account. + # + # @param id [String] + # @param account_id [String] + # @param account_number_id [String] + # @param amount [Integer] + # @param beneficiary_address_line1 [String, nil] + # @param beneficiary_address_line2 [String, nil] + # @param beneficiary_address_line3 [String, nil] + # @param beneficiary_name [String, nil] + # @param beneficiary_reference [String, nil] + # @param created_at [Time] + # @param description [String] + # @param input_message_accountability_data [String, nil] + # @param originator_address_line1 [String, nil] + # @param originator_address_line2 [String, nil] + # @param originator_address_line3 [String, nil] + # @param originator_name [String, nil] + # @param originator_routing_number [String, nil] + # @param originator_to_beneficiary_information [String, nil] + # @param originator_to_beneficiary_information_line1 [String, nil] + # @param originator_to_beneficiary_information_line2 [String, nil] + # @param originator_to_beneficiary_information_line3 [String, nil] + # @param originator_to_beneficiary_information_line4 [String, nil] + # @param sender_reference [String, nil] + # @param status [Symbol, Increase::Models::InboundWireTransfer::Status] + # @param type [Symbol, Increase::Models::InboundWireTransfer::Type] # The status of the transfer. # @@ -240,11 +207,8 @@ module Status # The Inbound Wire Transfer was reversed. REVERSED = :reversed - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # A constant representing the object's type. For this resource it will always be @@ -256,11 +220,8 @@ module Type INBOUND_WIRE_TRANSFER = :inbound_wire_transfer - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end diff --git a/lib/increase/models/inbound_wire_transfer_list_params.rb b/lib/increase/models/inbound_wire_transfer_list_params.rb index 9e814df3a..02a9b1397 100644 --- a/lib/increase/models/inbound_wire_transfer_list_params.rb +++ b/lib/increase/models/inbound_wire_transfer_list_params.rb @@ -4,151 +4,91 @@ module Increase module Models # @see Increase::Resources::InboundWireTransfers#list class InboundWireTransferListParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters - # @!attribute [r] account_id + # @!attribute account_id # Filter Inbound Wire Transfers to ones belonging to the specified Account. # # @return [String, nil] optional :account_id, String - # @!parse - # # @return [String] - # attr_writer :account_id - - # @!attribute [r] account_number_id + # @!attribute account_number_id # Filter Inbound Wire Transfers to ones belonging to the specified Account Number. # # @return [String, nil] optional :account_number_id, String - # @!parse - # # @return [String] - # attr_writer :account_number_id - - # @!attribute [r] created_at + # @!attribute created_at # # @return [Increase::Models::InboundWireTransferListParams::CreatedAt, nil] optional :created_at, -> { Increase::Models::InboundWireTransferListParams::CreatedAt } - # @!parse - # # @return [Increase::Models::InboundWireTransferListParams::CreatedAt] - # attr_writer :created_at - - # @!attribute [r] cursor + # @!attribute cursor # Return the page of entries after this one. # # @return [String, nil] optional :cursor, String - # @!parse - # # @return [String] - # attr_writer :cursor - - # @!attribute [r] limit + # @!attribute limit # Limit the size of the list that is returned. The default (and maximum) is 100 # objects. # # @return [Integer, nil] optional :limit, Integer - # @!parse - # # @return [Integer] - # attr_writer :limit - - # @!attribute [r] status + # @!attribute status # # @return [Increase::Models::InboundWireTransferListParams::Status, nil] optional :status, -> { Increase::Models::InboundWireTransferListParams::Status } - # @!parse - # # @return [Increase::Models::InboundWireTransferListParams::Status] - # attr_writer :status - - # @!parse - # # @param account_id [String] - # # @param account_number_id [String] - # # @param created_at [Increase::Models::InboundWireTransferListParams::CreatedAt] - # # @param cursor [String] - # # @param limit [Integer] - # # @param status [Increase::Models::InboundWireTransferListParams::Status] - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize( - # account_id: nil, - # account_number_id: nil, - # created_at: nil, - # cursor: nil, - # limit: nil, - # status: nil, - # request_options: {}, - # ** - # ) - # super - # end - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(account_id: nil, account_number_id: nil, created_at: nil, cursor: nil, limit: nil, status: nil, request_options: {}) + # @param account_id [String] + # @param account_number_id [String] + # @param created_at [Increase::Models::InboundWireTransferListParams::CreatedAt] + # @param cursor [String] + # @param limit [Integer] + # @param status [Increase::Models::InboundWireTransferListParams::Status] + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] class CreatedAt < Increase::Internal::Type::BaseModel - # @!attribute [r] after + # @!attribute after # Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) # timestamp. # # @return [Time, nil] optional :after, Time - # @!parse - # # @return [Time] - # attr_writer :after - - # @!attribute [r] before + # @!attribute before # Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) # timestamp. # # @return [Time, nil] optional :before, Time - # @!parse - # # @return [Time] - # attr_writer :before - - # @!attribute [r] on_or_after + # @!attribute on_or_after # Return results on or after this # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. # # @return [Time, nil] optional :on_or_after, Time - # @!parse - # # @return [Time] - # attr_writer :on_or_after - - # @!attribute [r] on_or_before + # @!attribute on_or_before # Return results on or before this # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. # # @return [Time, nil] optional :on_or_before, Time - # @!parse - # # @return [Time] - # attr_writer :on_or_before - - # @!parse - # # @param after [Time] - # # @param before [Time] - # # @param on_or_after [Time] - # # @param on_or_before [Time] - # # - # def initialize(after: nil, before: nil, on_or_after: nil, on_or_before: nil, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(after: nil, before: nil, on_or_after: nil, on_or_before: nil) + # @param after [Time] + # @param before [Time] + # @param on_or_after [Time] + # @param on_or_before [Time] end class Status < Increase::Internal::Type::BaseModel - # @!attribute [r] in_ + # @!attribute in_ # Filter Inbound Wire Transfers to those with the specified status. For GET # requests, this should be encoded as a comma-delimited string, such as # `?in=one,two,three`. @@ -158,16 +98,8 @@ class Status < Increase::Internal::Type::BaseModel -> { Increase::Internal::Type::ArrayOf[enum: Increase::Models::InboundWireTransferListParams::Status::In] }, api_name: :in - # @!parse - # # @return [Array] - # attr_writer :in_ - - # @!parse - # # @param in_ [Array] - # # - # def initialize(in_: nil, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(in_: nil) + # @param in_ [Array] module In extend Increase::Internal::Type::Enum @@ -184,11 +116,8 @@ module In # The Inbound Wire Transfer was reversed. REVERSED = :reversed - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end diff --git a/lib/increase/models/inbound_wire_transfer_retrieve_params.rb b/lib/increase/models/inbound_wire_transfer_retrieve_params.rb index a7e168fa7..208130a87 100644 --- a/lib/increase/models/inbound_wire_transfer_retrieve_params.rb +++ b/lib/increase/models/inbound_wire_transfer_retrieve_params.rb @@ -4,16 +4,11 @@ module Increase module Models # @see Increase::Resources::InboundWireTransfers#retrieve class InboundWireTransferRetrieveParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters - # @!parse - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(request_options: {}, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(request_options: {}) + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/increase/models/intrafi_account_enrollment.rb b/lib/increase/models/intrafi_account_enrollment.rb index db1b6f537..ff7dac814 100644 --- a/lib/increase/models/intrafi_account_enrollment.rb +++ b/lib/increase/models/intrafi_account_enrollment.rb @@ -52,26 +52,22 @@ class IntrafiAccountEnrollment < Increase::Internal::Type::BaseModel # @return [Symbol, Increase::Models::IntrafiAccountEnrollment::Type] required :type, enum: -> { Increase::Models::IntrafiAccountEnrollment::Type } - # @!parse - # # IntraFi is a - # # [network of financial institutions](https://www.intrafi.com/network-banks) that - # # allows Increase users to sweep funds to multiple banks, in addition to - # # Increase's main bank partners. This enables accounts to become eligible for - # # additional Federal Deposit Insurance Corporation (FDIC) insurance. An IntraFi - # # Account Enrollment object represents the status of an account in the network. - # # Sweeping an account to IntraFi doesn't affect funds availability. - # # - # # @param id [String] - # # @param account_id [String] - # # @param created_at [Time] - # # @param idempotency_key [String, nil] - # # @param intrafi_id [String] - # # @param status [Symbol, Increase::Models::IntrafiAccountEnrollment::Status] - # # @param type [Symbol, Increase::Models::IntrafiAccountEnrollment::Type] - # # - # def initialize(id:, account_id:, created_at:, idempotency_key:, intrafi_id:, status:, type:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(id:, account_id:, created_at:, idempotency_key:, intrafi_id:, status:, type:) + # IntraFi is a + # [network of financial institutions](https://www.intrafi.com/network-banks) that + # allows Increase users to sweep funds to multiple banks, in addition to + # Increase's main bank partners. This enables accounts to become eligible for + # additional Federal Deposit Insurance Corporation (FDIC) insurance. An IntraFi + # Account Enrollment object represents the status of an account in the network. + # Sweeping an account to IntraFi doesn't affect funds availability. + # + # @param id [String] + # @param account_id [String] + # @param created_at [Time] + # @param idempotency_key [String, nil] + # @param intrafi_id [String] + # @param status [Symbol, Increase::Models::IntrafiAccountEnrollment::Status] + # @param type [Symbol, Increase::Models::IntrafiAccountEnrollment::Type] # The status of the account in the network. An account takes about one business # day to go from `pending_enrolling` to `enrolled`. @@ -95,11 +91,8 @@ module Status # Something unexpected happened with this account. Contact Increase support. REQUIRES_ATTENTION = :requires_attention - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # A constant representing the object's type. For this resource it will always be @@ -111,11 +104,8 @@ module Type INTRAFI_ACCOUNT_ENROLLMENT = :intrafi_account_enrollment - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end diff --git a/lib/increase/models/intrafi_account_enrollment_create_params.rb b/lib/increase/models/intrafi_account_enrollment_create_params.rb index ea377c052..51b4843c1 100644 --- a/lib/increase/models/intrafi_account_enrollment_create_params.rb +++ b/lib/increase/models/intrafi_account_enrollment_create_params.rb @@ -4,8 +4,7 @@ module Increase module Models # @see Increase::Resources::IntrafiAccountEnrollments#create class IntrafiAccountEnrollmentCreateParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters # @!attribute account_id @@ -20,14 +19,10 @@ class IntrafiAccountEnrollmentCreateParams < Increase::Internal::Type::BaseModel # @return [String] required :email_address, String - # @!parse - # # @param account_id [String] - # # @param email_address [String] - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(account_id:, email_address:, request_options: {}, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(account_id:, email_address:, request_options: {}) + # @param account_id [String] + # @param email_address [String] + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/increase/models/intrafi_account_enrollment_list_params.rb b/lib/increase/models/intrafi_account_enrollment_list_params.rb index 329dc1d13..138c5b1ab 100644 --- a/lib/increase/models/intrafi_account_enrollment_list_params.rb +++ b/lib/increase/models/intrafi_account_enrollment_list_params.rb @@ -4,31 +4,22 @@ module Increase module Models # @see Increase::Resources::IntrafiAccountEnrollments#list class IntrafiAccountEnrollmentListParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters - # @!attribute [r] account_id + # @!attribute account_id # Filter IntraFi Account Enrollments to the one belonging to an account. # # @return [String, nil] optional :account_id, String - # @!parse - # # @return [String] - # attr_writer :account_id - - # @!attribute [r] cursor + # @!attribute cursor # Return the page of entries after this one. # # @return [String, nil] optional :cursor, String - # @!parse - # # @return [String] - # attr_writer :cursor - - # @!attribute [r] idempotency_key + # @!attribute idempotency_key # Filter records to the one with the specified `idempotency_key` you chose for # that object. This value is unique across Increase and is used to ensure that a # request is only processed once. Learn more about @@ -37,44 +28,28 @@ class IntrafiAccountEnrollmentListParams < Increase::Internal::Type::BaseModel # @return [String, nil] optional :idempotency_key, String - # @!parse - # # @return [String] - # attr_writer :idempotency_key - - # @!attribute [r] limit + # @!attribute limit # Limit the size of the list that is returned. The default (and maximum) is 100 # objects. # # @return [Integer, nil] optional :limit, Integer - # @!parse - # # @return [Integer] - # attr_writer :limit - - # @!attribute [r] status + # @!attribute status # # @return [Increase::Models::IntrafiAccountEnrollmentListParams::Status, nil] optional :status, -> { Increase::Models::IntrafiAccountEnrollmentListParams::Status } - # @!parse - # # @return [Increase::Models::IntrafiAccountEnrollmentListParams::Status] - # attr_writer :status - - # @!parse - # # @param account_id [String] - # # @param cursor [String] - # # @param idempotency_key [String] - # # @param limit [Integer] - # # @param status [Increase::Models::IntrafiAccountEnrollmentListParams::Status] - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(account_id: nil, cursor: nil, idempotency_key: nil, limit: nil, status: nil, request_options: {}, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(account_id: nil, cursor: nil, idempotency_key: nil, limit: nil, status: nil, request_options: {}) + # @param account_id [String] + # @param cursor [String] + # @param idempotency_key [String] + # @param limit [Integer] + # @param status [Increase::Models::IntrafiAccountEnrollmentListParams::Status] + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] class Status < Increase::Internal::Type::BaseModel - # @!attribute [r] in_ + # @!attribute in_ # Filter IntraFi Account Enrollments for those with the specified status or # statuses. For GET requests, this should be encoded as a comma-delimited string, # such as `?in=one,two,three`. @@ -84,16 +59,8 @@ class Status < Increase::Internal::Type::BaseModel -> { Increase::Internal::Type::ArrayOf[enum: Increase::Models::IntrafiAccountEnrollmentListParams::Status::In] }, api_name: :in - # @!parse - # # @return [Array] - # attr_writer :in_ - - # @!parse - # # @param in_ [Array] - # # - # def initialize(in_: nil, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(in_: nil) + # @param in_ [Array] module In extend Increase::Internal::Type::Enum @@ -113,11 +80,8 @@ module In # Something unexpected happened with this account. Contact Increase support. REQUIRES_ATTENTION = :requires_attention - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end diff --git a/lib/increase/models/intrafi_account_enrollment_retrieve_params.rb b/lib/increase/models/intrafi_account_enrollment_retrieve_params.rb index 4817af392..b6127379e 100644 --- a/lib/increase/models/intrafi_account_enrollment_retrieve_params.rb +++ b/lib/increase/models/intrafi_account_enrollment_retrieve_params.rb @@ -4,16 +4,11 @@ module Increase module Models # @see Increase::Resources::IntrafiAccountEnrollments#retrieve class IntrafiAccountEnrollmentRetrieveParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters - # @!parse - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(request_options: {}, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(request_options: {}) + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/increase/models/intrafi_account_enrollment_unenroll_params.rb b/lib/increase/models/intrafi_account_enrollment_unenroll_params.rb index 4f2664dad..2d91d503a 100644 --- a/lib/increase/models/intrafi_account_enrollment_unenroll_params.rb +++ b/lib/increase/models/intrafi_account_enrollment_unenroll_params.rb @@ -4,16 +4,11 @@ module Increase module Models # @see Increase::Resources::IntrafiAccountEnrollments#unenroll class IntrafiAccountEnrollmentUnenrollParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters - # @!parse - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(request_options: {}, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(request_options: {}) + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/increase/models/intrafi_balance.rb b/lib/increase/models/intrafi_balance.rb index 62680a244..63f57ab75 100644 --- a/lib/increase/models/intrafi_balance.rb +++ b/lib/increase/models/intrafi_balance.rb @@ -44,21 +44,17 @@ class IntrafiBalance < Increase::Internal::Type::BaseModel # @return [Symbol, Increase::Models::IntrafiBalance::Type] required :type, enum: -> { Increase::Models::IntrafiBalance::Type } - # @!parse - # # When using IntraFi, each account's balance over the standard FDIC insurance - # # amount are swept to various other institutions. Funds are rebalanced across - # # banks as needed once per business day. - # # - # # @param id [String] - # # @param balances [Array] - # # @param currency [Symbol, Increase::Models::IntrafiBalance::Currency] - # # @param effective_date [Date] - # # @param total_balance [Integer] - # # @param type [Symbol, Increase::Models::IntrafiBalance::Type] - # # - # def initialize(id:, balances:, currency:, effective_date:, total_balance:, type:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(id:, balances:, currency:, effective_date:, total_balance:, type:) + # When using IntraFi, each account's balance over the standard FDIC insurance + # amount are swept to various other institutions. Funds are rebalanced across + # banks as needed once per business day. + # + # @param id [String] + # @param balances [Array] + # @param currency [Symbol, Increase::Models::IntrafiBalance::Currency] + # @param effective_date [Date] + # @param total_balance [Integer] + # @param type [Symbol, Increase::Models::IntrafiBalance::Type] class Balance < Increase::Internal::Type::BaseModel # @!attribute id @@ -93,16 +89,12 @@ class Balance < Increase::Internal::Type::BaseModel # @return [String] required :fdic_certificate_number, String - # @!parse - # # @param id [String] - # # @param balance [Integer] - # # @param bank [String] - # # @param bank_location [Increase::Models::IntrafiBalance::Balance::BankLocation, nil] - # # @param fdic_certificate_number [String] - # # - # def initialize(id:, balance:, bank:, bank_location:, fdic_certificate_number:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(id:, balance:, bank:, bank_location:, fdic_certificate_number:) + # @param id [String] + # @param balance [Integer] + # @param bank [String] + # @param bank_location [Increase::Models::IntrafiBalance::Balance::BankLocation, nil] + # @param fdic_certificate_number [String] # @see Increase::Models::IntrafiBalance::Balance#bank_location class BankLocation < Increase::Internal::Type::BaseModel @@ -118,15 +110,11 @@ class BankLocation < Increase::Internal::Type::BaseModel # @return [String] required :state, String - # @!parse - # # The primary location of the bank. - # # - # # @param city [String] - # # @param state [String] - # # - # def initialize(city:, state:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(city:, state:) + # The primary location of the bank. + # + # @param city [String] + # @param state [String] end end @@ -155,11 +143,8 @@ module Currency # US Dollar (USD) USD = :USD - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # A constant representing the object's type. For this resource it will always be @@ -171,11 +156,8 @@ module Type INTRAFI_BALANCE = :intrafi_balance - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end diff --git a/lib/increase/models/intrafi_balance_intrafi_balance_params.rb b/lib/increase/models/intrafi_balance_intrafi_balance_params.rb index aeaf1d5fb..2d1852b57 100644 --- a/lib/increase/models/intrafi_balance_intrafi_balance_params.rb +++ b/lib/increase/models/intrafi_balance_intrafi_balance_params.rb @@ -4,16 +4,11 @@ module Increase module Models # @see Increase::Resources::IntrafiBalances#intrafi_balance class IntrafiBalanceIntrafiBalanceParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters - # @!parse - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(request_options: {}, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(request_options: {}) + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/increase/models/intrafi_exclusion.rb b/lib/increase/models/intrafi_exclusion.rb index e6ad0270d..dc899728b 100644 --- a/lib/increase/models/intrafi_exclusion.rb +++ b/lib/increase/models/intrafi_exclusion.rb @@ -69,40 +69,22 @@ class IntrafiExclusion < Increase::Internal::Type::BaseModel # @return [Symbol, Increase::Models::IntrafiExclusion::Type] required :type, enum: -> { Increase::Models::IntrafiExclusion::Type } - # @!parse - # # Certain institutions may be excluded per Entity when sweeping funds into the - # # IntraFi network. This is useful when an Entity already has deposits at a - # # particular bank, and does not want to sweep additional funds to it. It may take - # # 5 business days for an exclusion to be processed. - # # - # # @param id [String] - # # @param bank_name [String] - # # @param created_at [Time] - # # @param entity_id [String] - # # @param excluded_at [Time, nil] - # # @param fdic_certificate_number [String, nil] - # # @param idempotency_key [String, nil] - # # @param status [Symbol, Increase::Models::IntrafiExclusion::Status] - # # @param submitted_at [Time, nil] - # # @param type [Symbol, Increase::Models::IntrafiExclusion::Type] - # # - # def initialize( - # id:, - # bank_name:, - # created_at:, - # entity_id:, - # excluded_at:, - # fdic_certificate_number:, - # idempotency_key:, - # status:, - # submitted_at:, - # type:, - # ** - # ) - # super - # end - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(id:, bank_name:, created_at:, entity_id:, excluded_at:, fdic_certificate_number:, idempotency_key:, status:, submitted_at:, type:) + # Certain institutions may be excluded per Entity when sweeping funds into the + # IntraFi network. This is useful when an Entity already has deposits at a + # particular bank, and does not want to sweep additional funds to it. It may take + # 5 business days for an exclusion to be processed. + # + # @param id [String] + # @param bank_name [String] + # @param created_at [Time] + # @param entity_id [String] + # @param excluded_at [Time, nil] + # @param fdic_certificate_number [String, nil] + # @param idempotency_key [String, nil] + # @param status [Symbol, Increase::Models::IntrafiExclusion::Status] + # @param submitted_at [Time, nil] + # @param type [Symbol, Increase::Models::IntrafiExclusion::Type] # The status of the exclusion request. # @@ -119,11 +101,8 @@ module Status # The exclusion has been removed from the IntraFi network. ARCHIVED = :archived - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # A constant representing the object's type. For this resource it will always be @@ -135,11 +114,8 @@ module Type INTRAFI_EXCLUSION = :intrafi_exclusion - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end diff --git a/lib/increase/models/intrafi_exclusion_archive_params.rb b/lib/increase/models/intrafi_exclusion_archive_params.rb index fe8a78f0f..acbbf04c3 100644 --- a/lib/increase/models/intrafi_exclusion_archive_params.rb +++ b/lib/increase/models/intrafi_exclusion_archive_params.rb @@ -4,16 +4,11 @@ module Increase module Models # @see Increase::Resources::IntrafiExclusions#archive class IntrafiExclusionArchiveParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters - # @!parse - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(request_options: {}, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(request_options: {}) + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/increase/models/intrafi_exclusion_create_params.rb b/lib/increase/models/intrafi_exclusion_create_params.rb index fa079df0a..7f8c7183e 100644 --- a/lib/increase/models/intrafi_exclusion_create_params.rb +++ b/lib/increase/models/intrafi_exclusion_create_params.rb @@ -4,8 +4,7 @@ module Increase module Models # @see Increase::Resources::IntrafiExclusions#create class IntrafiExclusionCreateParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters # @!attribute bank_name @@ -20,14 +19,10 @@ class IntrafiExclusionCreateParams < Increase::Internal::Type::BaseModel # @return [String] required :entity_id, String - # @!parse - # # @param bank_name [String] - # # @param entity_id [String] - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(bank_name:, entity_id:, request_options: {}, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(bank_name:, entity_id:, request_options: {}) + # @param bank_name [String] + # @param entity_id [String] + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/increase/models/intrafi_exclusion_list_params.rb b/lib/increase/models/intrafi_exclusion_list_params.rb index e7d488431..d823c9736 100644 --- a/lib/increase/models/intrafi_exclusion_list_params.rb +++ b/lib/increase/models/intrafi_exclusion_list_params.rb @@ -4,31 +4,22 @@ module Increase module Models # @see Increase::Resources::IntrafiExclusions#list class IntrafiExclusionListParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters - # @!attribute [r] cursor + # @!attribute cursor # Return the page of entries after this one. # # @return [String, nil] optional :cursor, String - # @!parse - # # @return [String] - # attr_writer :cursor - - # @!attribute [r] entity_id + # @!attribute entity_id # Filter IntraFi Exclusions for those belonging to the specified Entity. # # @return [String, nil] optional :entity_id, String - # @!parse - # # @return [String] - # attr_writer :entity_id - - # @!attribute [r] idempotency_key + # @!attribute idempotency_key # Filter records to the one with the specified `idempotency_key` you chose for # that object. This value is unique across Increase and is used to ensure that a # request is only processed once. Learn more about @@ -37,31 +28,19 @@ class IntrafiExclusionListParams < Increase::Internal::Type::BaseModel # @return [String, nil] optional :idempotency_key, String - # @!parse - # # @return [String] - # attr_writer :idempotency_key - - # @!attribute [r] limit + # @!attribute limit # Limit the size of the list that is returned. The default (and maximum) is 100 # objects. # # @return [Integer, nil] optional :limit, Integer - # @!parse - # # @return [Integer] - # attr_writer :limit - - # @!parse - # # @param cursor [String] - # # @param entity_id [String] - # # @param idempotency_key [String] - # # @param limit [Integer] - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(cursor: nil, entity_id: nil, idempotency_key: nil, limit: nil, request_options: {}, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(cursor: nil, entity_id: nil, idempotency_key: nil, limit: nil, request_options: {}) + # @param cursor [String] + # @param entity_id [String] + # @param idempotency_key [String] + # @param limit [Integer] + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/increase/models/intrafi_exclusion_retrieve_params.rb b/lib/increase/models/intrafi_exclusion_retrieve_params.rb index 53145ada0..6ee49afb0 100644 --- a/lib/increase/models/intrafi_exclusion_retrieve_params.rb +++ b/lib/increase/models/intrafi_exclusion_retrieve_params.rb @@ -4,16 +4,11 @@ module Increase module Models # @see Increase::Resources::IntrafiExclusions#retrieve class IntrafiExclusionRetrieveParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters - # @!parse - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(request_options: {}, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(request_options: {}) + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/increase/models/lockbox.rb b/lib/increase/models/lockbox.rb index e85511968..85fe1e38b 100644 --- a/lib/increase/models/lockbox.rb +++ b/lib/increase/models/lockbox.rb @@ -63,36 +63,19 @@ class Lockbox < Increase::Internal::Type::BaseModel # @return [Symbol, Increase::Models::Lockbox::Type] required :type, enum: -> { Increase::Models::Lockbox::Type } - # @!parse - # # Lockboxes are physical locations that can receive mail containing paper checks. - # # Increase will automatically create a Check Deposit for checks received this way. - # # - # # @param id [String] - # # @param account_id [String] - # # @param address [Increase::Models::Lockbox::Address] - # # @param created_at [Time] - # # @param description [String, nil] - # # @param idempotency_key [String, nil] - # # @param recipient_name [String, nil] - # # @param status [Symbol, Increase::Models::Lockbox::Status] - # # @param type [Symbol, Increase::Models::Lockbox::Type] - # # - # def initialize( - # id:, - # account_id:, - # address:, - # created_at:, - # description:, - # idempotency_key:, - # recipient_name:, - # status:, - # type:, - # ** - # ) - # super - # end - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(id:, account_id:, address:, created_at:, description:, idempotency_key:, recipient_name:, status:, type:) + # Lockboxes are physical locations that can receive mail containing paper checks. + # Increase will automatically create a Check Deposit for checks received this way. + # + # @param id [String] + # @param account_id [String] + # @param address [Increase::Models::Lockbox::Address] + # @param created_at [Time] + # @param description [String, nil] + # @param idempotency_key [String, nil] + # @param recipient_name [String, nil] + # @param status [Symbol, Increase::Models::Lockbox::Status] + # @param type [Symbol, Increase::Models::Lockbox::Type] # @see Increase::Models::Lockbox#address class Address < Increase::Internal::Type::BaseModel @@ -136,19 +119,15 @@ class Address < Increase::Internal::Type::BaseModel # @return [String] required :state, String - # @!parse - # # The mailing address for the Lockbox. - # # - # # @param city [String] - # # @param line1 [String] - # # @param line2 [String] - # # @param postal_code [String] - # # @param recipient [String, nil] - # # @param state [String] - # # - # def initialize(city:, line1:, line2:, postal_code:, recipient:, state:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(city:, line1:, line2:, postal_code:, recipient:, state:) + # The mailing address for the Lockbox. + # + # @param city [String] + # @param line1 [String] + # @param line2 [String] + # @param postal_code [String] + # @param recipient [String, nil] + # @param state [String] end # This indicates if mail can be sent to this address. @@ -163,11 +142,8 @@ module Status # This Lockbox is inactive. Checks mailed to it will not be deposited. INACTIVE = :inactive - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # A constant representing the object's type. For this resource it will always be @@ -179,11 +155,8 @@ module Type LOCKBOX = :lockbox - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end diff --git a/lib/increase/models/lockbox_create_params.rb b/lib/increase/models/lockbox_create_params.rb index aebca9e31..70fa558ad 100644 --- a/lib/increase/models/lockbox_create_params.rb +++ b/lib/increase/models/lockbox_create_params.rb @@ -4,8 +4,7 @@ module Increase module Models # @see Increase::Resources::Lockboxes#create class LockboxCreateParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters # @!attribute account_id @@ -14,35 +13,23 @@ class LockboxCreateParams < Increase::Internal::Type::BaseModel # @return [String] required :account_id, String - # @!attribute [r] description + # @!attribute description # The description you choose for the Lockbox, for display purposes. # # @return [String, nil] optional :description, String - # @!parse - # # @return [String] - # attr_writer :description - - # @!attribute [r] recipient_name + # @!attribute recipient_name # The name of the recipient that will receive mail at this location. # # @return [String, nil] optional :recipient_name, String - # @!parse - # # @return [String] - # attr_writer :recipient_name - - # @!parse - # # @param account_id [String] - # # @param description [String] - # # @param recipient_name [String] - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(account_id:, description: nil, recipient_name: nil, request_options: {}, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(account_id:, description: nil, recipient_name: nil, request_options: {}) + # @param account_id [String] + # @param description [String] + # @param recipient_name [String] + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/increase/models/lockbox_list_params.rb b/lib/increase/models/lockbox_list_params.rb index 26d51c9df..08e10245b 100644 --- a/lib/increase/models/lockbox_list_params.rb +++ b/lib/increase/models/lockbox_list_params.rb @@ -4,40 +4,27 @@ module Increase module Models # @see Increase::Resources::Lockboxes#list class LockboxListParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters - # @!attribute [r] account_id + # @!attribute account_id # Filter Lockboxes to those associated with the provided Account. # # @return [String, nil] optional :account_id, String - # @!parse - # # @return [String] - # attr_writer :account_id - - # @!attribute [r] created_at + # @!attribute created_at # # @return [Increase::Models::LockboxListParams::CreatedAt, nil] optional :created_at, -> { Increase::Models::LockboxListParams::CreatedAt } - # @!parse - # # @return [Increase::Models::LockboxListParams::CreatedAt] - # attr_writer :created_at - - # @!attribute [r] cursor + # @!attribute cursor # Return the page of entries after this one. # # @return [String, nil] optional :cursor, String - # @!parse - # # @return [String] - # attr_writer :cursor - - # @!attribute [r] idempotency_key + # @!attribute idempotency_key # Filter records to the one with the specified `idempotency_key` you chose for # that object. This value is unique across Increase and is used to ensure that a # request is only processed once. Learn more about @@ -46,87 +33,55 @@ class LockboxListParams < Increase::Internal::Type::BaseModel # @return [String, nil] optional :idempotency_key, String - # @!parse - # # @return [String] - # attr_writer :idempotency_key - - # @!attribute [r] limit + # @!attribute limit # Limit the size of the list that is returned. The default (and maximum) is 100 # objects. # # @return [Integer, nil] optional :limit, Integer - # @!parse - # # @return [Integer] - # attr_writer :limit - - # @!parse - # # @param account_id [String] - # # @param created_at [Increase::Models::LockboxListParams::CreatedAt] - # # @param cursor [String] - # # @param idempotency_key [String] - # # @param limit [Integer] - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(account_id: nil, created_at: nil, cursor: nil, idempotency_key: nil, limit: nil, request_options: {}, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(account_id: nil, created_at: nil, cursor: nil, idempotency_key: nil, limit: nil, request_options: {}) + # @param account_id [String] + # @param created_at [Increase::Models::LockboxListParams::CreatedAt] + # @param cursor [String] + # @param idempotency_key [String] + # @param limit [Integer] + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] class CreatedAt < Increase::Internal::Type::BaseModel - # @!attribute [r] after + # @!attribute after # Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) # timestamp. # # @return [Time, nil] optional :after, Time - # @!parse - # # @return [Time] - # attr_writer :after - - # @!attribute [r] before + # @!attribute before # Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) # timestamp. # # @return [Time, nil] optional :before, Time - # @!parse - # # @return [Time] - # attr_writer :before - - # @!attribute [r] on_or_after + # @!attribute on_or_after # Return results on or after this # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. # # @return [Time, nil] optional :on_or_after, Time - # @!parse - # # @return [Time] - # attr_writer :on_or_after - - # @!attribute [r] on_or_before + # @!attribute on_or_before # Return results on or before this # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. # # @return [Time, nil] optional :on_or_before, Time - # @!parse - # # @return [Time] - # attr_writer :on_or_before - - # @!parse - # # @param after [Time] - # # @param before [Time] - # # @param on_or_after [Time] - # # @param on_or_before [Time] - # # - # def initialize(after: nil, before: nil, on_or_after: nil, on_or_before: nil, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(after: nil, before: nil, on_or_after: nil, on_or_before: nil) + # @param after [Time] + # @param before [Time] + # @param on_or_after [Time] + # @param on_or_before [Time] end end end diff --git a/lib/increase/models/lockbox_retrieve_params.rb b/lib/increase/models/lockbox_retrieve_params.rb index ab82a8e8b..75d05cfab 100644 --- a/lib/increase/models/lockbox_retrieve_params.rb +++ b/lib/increase/models/lockbox_retrieve_params.rb @@ -4,16 +4,11 @@ module Increase module Models # @see Increase::Resources::Lockboxes#retrieve class LockboxRetrieveParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters - # @!parse - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(request_options: {}, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(request_options: {}) + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/increase/models/lockbox_update_params.rb b/lib/increase/models/lockbox_update_params.rb index bb87ca21d..45536c9fa 100644 --- a/lib/increase/models/lockbox_update_params.rb +++ b/lib/increase/models/lockbox_update_params.rb @@ -4,49 +4,32 @@ module Increase module Models # @see Increase::Resources::Lockboxes#update class LockboxUpdateParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters - # @!attribute [r] description + # @!attribute description # The description you choose for the Lockbox. # # @return [String, nil] optional :description, String - # @!parse - # # @return [String] - # attr_writer :description - - # @!attribute [r] recipient_name + # @!attribute recipient_name # The recipient name you choose for the Lockbox. # # @return [String, nil] optional :recipient_name, String - # @!parse - # # @return [String] - # attr_writer :recipient_name - - # @!attribute [r] status + # @!attribute status # This indicates if checks can be sent to the Lockbox. # # @return [Symbol, Increase::Models::LockboxUpdateParams::Status, nil] optional :status, enum: -> { Increase::Models::LockboxUpdateParams::Status } - # @!parse - # # @return [Symbol, Increase::Models::LockboxUpdateParams::Status] - # attr_writer :status - - # @!parse - # # @param description [String] - # # @param recipient_name [String] - # # @param status [Symbol, Increase::Models::LockboxUpdateParams::Status] - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(description: nil, recipient_name: nil, status: nil, request_options: {}, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(description: nil, recipient_name: nil, status: nil, request_options: {}) + # @param description [String] + # @param recipient_name [String] + # @param status [Symbol, Increase::Models::LockboxUpdateParams::Status] + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] # This indicates if checks can be sent to the Lockbox. module Status @@ -58,11 +41,8 @@ module Status # This Lockbox is inactive. Checks mailed to it will not be deposited. INACTIVE = :inactive - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end diff --git a/lib/increase/models/oauth_application.rb b/lib/increase/models/oauth_application.rb index c9673d61e..46f2dc1e5 100644 --- a/lib/increase/models/oauth_application.rb +++ b/lib/increase/models/oauth_application.rb @@ -50,23 +50,19 @@ class OAuthApplication < Increase::Internal::Type::BaseModel # @return [Symbol, Increase::Models::OAuthApplication::Type] required :type, enum: -> { Increase::Models::OAuthApplication::Type } - # @!parse - # # An OAuth Application lets you build an application for others to use with their - # # Increase data. You can create an OAuth Application via the Dashboard and read - # # information about it with the API. Learn more about OAuth - # # [here](https://increase.com/documentation/oauth). - # # - # # @param id [String] - # # @param client_id [String] - # # @param created_at [Time] - # # @param deleted_at [Time, nil] - # # @param name [String, nil] - # # @param status [Symbol, Increase::Models::OAuthApplication::Status] - # # @param type [Symbol, Increase::Models::OAuthApplication::Type] - # # - # def initialize(id:, client_id:, created_at:, deleted_at:, name:, status:, type:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(id:, client_id:, created_at:, deleted_at:, name:, status:, type:) + # An OAuth Application lets you build an application for others to use with their + # Increase data. You can create an OAuth Application via the Dashboard and read + # information about it with the API. Learn more about OAuth + # [here](https://increase.com/documentation/oauth). + # + # @param id [String] + # @param client_id [String] + # @param created_at [Time] + # @param deleted_at [Time, nil] + # @param name [String, nil] + # @param status [Symbol, Increase::Models::OAuthApplication::Status] + # @param type [Symbol, Increase::Models::OAuthApplication::Type] # Whether the application is active. # @@ -80,11 +76,8 @@ module Status # The application is deleted. DELETED = :deleted - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # A constant representing the object's type. For this resource it will always be @@ -96,11 +89,8 @@ module Type OAUTH_APPLICATION = :oauth_application - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end diff --git a/lib/increase/models/oauth_application_list_params.rb b/lib/increase/models/oauth_application_list_params.rb index 9c4f769c0..619a32a18 100644 --- a/lib/increase/models/oauth_application_list_params.rb +++ b/lib/increase/models/oauth_application_list_params.rb @@ -4,118 +4,77 @@ module Increase module Models # @see Increase::Resources::OAuthApplications#list class OAuthApplicationListParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters - # @!attribute [r] created_at + # @!attribute created_at # # @return [Increase::Models::OAuthApplicationListParams::CreatedAt, nil] optional :created_at, -> { Increase::Models::OAuthApplicationListParams::CreatedAt } - # @!parse - # # @return [Increase::Models::OAuthApplicationListParams::CreatedAt] - # attr_writer :created_at - - # @!attribute [r] cursor + # @!attribute cursor # Return the page of entries after this one. # # @return [String, nil] optional :cursor, String - # @!parse - # # @return [String] - # attr_writer :cursor - - # @!attribute [r] limit + # @!attribute limit # Limit the size of the list that is returned. The default (and maximum) is 100 # objects. # # @return [Integer, nil] optional :limit, Integer - # @!parse - # # @return [Integer] - # attr_writer :limit - - # @!attribute [r] status + # @!attribute status # # @return [Increase::Models::OAuthApplicationListParams::Status, nil] optional :status, -> { Increase::Models::OAuthApplicationListParams::Status } - # @!parse - # # @return [Increase::Models::OAuthApplicationListParams::Status] - # attr_writer :status - - # @!parse - # # @param created_at [Increase::Models::OAuthApplicationListParams::CreatedAt] - # # @param cursor [String] - # # @param limit [Integer] - # # @param status [Increase::Models::OAuthApplicationListParams::Status] - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(created_at: nil, cursor: nil, limit: nil, status: nil, request_options: {}, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(created_at: nil, cursor: nil, limit: nil, status: nil, request_options: {}) + # @param created_at [Increase::Models::OAuthApplicationListParams::CreatedAt] + # @param cursor [String] + # @param limit [Integer] + # @param status [Increase::Models::OAuthApplicationListParams::Status] + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] class CreatedAt < Increase::Internal::Type::BaseModel - # @!attribute [r] after + # @!attribute after # Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) # timestamp. # # @return [Time, nil] optional :after, Time - # @!parse - # # @return [Time] - # attr_writer :after - - # @!attribute [r] before + # @!attribute before # Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) # timestamp. # # @return [Time, nil] optional :before, Time - # @!parse - # # @return [Time] - # attr_writer :before - - # @!attribute [r] on_or_after + # @!attribute on_or_after # Return results on or after this # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. # # @return [Time, nil] optional :on_or_after, Time - # @!parse - # # @return [Time] - # attr_writer :on_or_after - - # @!attribute [r] on_or_before + # @!attribute on_or_before # Return results on or before this # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. # # @return [Time, nil] optional :on_or_before, Time - # @!parse - # # @return [Time] - # attr_writer :on_or_before - - # @!parse - # # @param after [Time] - # # @param before [Time] - # # @param on_or_after [Time] - # # @param on_or_before [Time] - # # - # def initialize(after: nil, before: nil, on_or_after: nil, on_or_before: nil, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(after: nil, before: nil, on_or_after: nil, on_or_before: nil) + # @param after [Time] + # @param before [Time] + # @param on_or_after [Time] + # @param on_or_before [Time] end class Status < Increase::Internal::Type::BaseModel - # @!attribute [r] in_ + # @!attribute in_ # Return results whose value is in the provided list. For GET requests, this # should be encoded as a comma-delimited string, such as `?in=one,two,three`. # @@ -124,16 +83,8 @@ class Status < Increase::Internal::Type::BaseModel -> { Increase::Internal::Type::ArrayOf[enum: Increase::Models::OAuthApplicationListParams::Status::In] }, api_name: :in - # @!parse - # # @return [Array] - # attr_writer :in_ - - # @!parse - # # @param in_ [Array] - # # - # def initialize(in_: nil, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(in_: nil) + # @param in_ [Array] module In extend Increase::Internal::Type::Enum @@ -144,11 +95,8 @@ module In # The application is deleted. DELETED = :deleted - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end diff --git a/lib/increase/models/oauth_application_retrieve_params.rb b/lib/increase/models/oauth_application_retrieve_params.rb index fec892fc6..ff50c033b 100644 --- a/lib/increase/models/oauth_application_retrieve_params.rb +++ b/lib/increase/models/oauth_application_retrieve_params.rb @@ -4,16 +4,11 @@ module Increase module Models # @see Increase::Resources::OAuthApplications#retrieve class OAuthApplicationRetrieveParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters - # @!parse - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(request_options: {}, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(request_options: {}) + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/increase/models/oauth_connection.rb b/lib/increase/models/oauth_connection.rb index b385900ff..fb2a6ac68 100644 --- a/lib/increase/models/oauth_connection.rb +++ b/lib/increase/models/oauth_connection.rb @@ -49,22 +49,18 @@ class OAuthConnection < Increase::Internal::Type::BaseModel # @return [Symbol, Increase::Models::OAuthConnection::Type] required :type, enum: -> { Increase::Models::OAuthConnection::Type } - # @!parse - # # When a user authorizes your OAuth application, an OAuth Connection object is - # # created. Learn more about OAuth - # # [here](https://increase.com/documentation/oauth). - # # - # # @param id [String] - # # @param created_at [Time] - # # @param deleted_at [Time, nil] - # # @param group_id [String] - # # @param oauth_application_id [String] - # # @param status [Symbol, Increase::Models::OAuthConnection::Status] - # # @param type [Symbol, Increase::Models::OAuthConnection::Type] - # # - # def initialize(id:, created_at:, deleted_at:, group_id:, oauth_application_id:, status:, type:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(id:, created_at:, deleted_at:, group_id:, oauth_application_id:, status:, type:) + # When a user authorizes your OAuth application, an OAuth Connection object is + # created. Learn more about OAuth + # [here](https://increase.com/documentation/oauth). + # + # @param id [String] + # @param created_at [Time] + # @param deleted_at [Time, nil] + # @param group_id [String] + # @param oauth_application_id [String] + # @param status [Symbol, Increase::Models::OAuthConnection::Status] + # @param type [Symbol, Increase::Models::OAuthConnection::Type] # Whether the connection is active. # @@ -78,11 +74,8 @@ module Status # The OAuth connection is permanently deactivated. INACTIVE = :inactive - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # A constant representing the object's type. For this resource it will always be @@ -94,11 +87,8 @@ module Type OAUTH_CONNECTION = :oauth_connection - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end diff --git a/lib/increase/models/oauth_connection_list_params.rb b/lib/increase/models/oauth_connection_list_params.rb index a4f0308fb..e2c74b80d 100644 --- a/lib/increase/models/oauth_connection_list_params.rb +++ b/lib/increase/models/oauth_connection_list_params.rb @@ -4,64 +4,43 @@ module Increase module Models # @see Increase::Resources::OAuthConnections#list class OAuthConnectionListParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters - # @!attribute [r] cursor + # @!attribute cursor # Return the page of entries after this one. # # @return [String, nil] optional :cursor, String - # @!parse - # # @return [String] - # attr_writer :cursor - - # @!attribute [r] limit + # @!attribute limit # Limit the size of the list that is returned. The default (and maximum) is 100 # objects. # # @return [Integer, nil] optional :limit, Integer - # @!parse - # # @return [Integer] - # attr_writer :limit - - # @!attribute [r] oauth_application_id + # @!attribute oauth_application_id # Filter results to only include OAuth Connections for a specific OAuth # Application. # # @return [String, nil] optional :oauth_application_id, String - # @!parse - # # @return [String] - # attr_writer :oauth_application_id - - # @!attribute [r] status + # @!attribute status # # @return [Increase::Models::OAuthConnectionListParams::Status, nil] optional :status, -> { Increase::Models::OAuthConnectionListParams::Status } - # @!parse - # # @return [Increase::Models::OAuthConnectionListParams::Status] - # attr_writer :status - - # @!parse - # # @param cursor [String] - # # @param limit [Integer] - # # @param oauth_application_id [String] - # # @param status [Increase::Models::OAuthConnectionListParams::Status] - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(cursor: nil, limit: nil, oauth_application_id: nil, status: nil, request_options: {}, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(cursor: nil, limit: nil, oauth_application_id: nil, status: nil, request_options: {}) + # @param cursor [String] + # @param limit [Integer] + # @param oauth_application_id [String] + # @param status [Increase::Models::OAuthConnectionListParams::Status] + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] class Status < Increase::Internal::Type::BaseModel - # @!attribute [r] in_ + # @!attribute in_ # Filter to OAuth Connections by their status. By default, return only the # `active` ones. For GET requests, this should be encoded as a comma-delimited # string, such as `?in=one,two,three`. @@ -71,16 +50,8 @@ class Status < Increase::Internal::Type::BaseModel -> { Increase::Internal::Type::ArrayOf[enum: Increase::Models::OAuthConnectionListParams::Status::In] }, api_name: :in - # @!parse - # # @return [Array] - # attr_writer :in_ - - # @!parse - # # @param in_ [Array] - # # - # def initialize(in_: nil, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(in_: nil) + # @param in_ [Array] module In extend Increase::Internal::Type::Enum @@ -91,11 +62,8 @@ module In # The OAuth connection is permanently deactivated. INACTIVE = :inactive - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end diff --git a/lib/increase/models/oauth_connection_retrieve_params.rb b/lib/increase/models/oauth_connection_retrieve_params.rb index 46d6658de..42af89d73 100644 --- a/lib/increase/models/oauth_connection_retrieve_params.rb +++ b/lib/increase/models/oauth_connection_retrieve_params.rb @@ -4,16 +4,11 @@ module Increase module Models # @see Increase::Resources::OAuthConnections#retrieve class OAuthConnectionRetrieveParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters - # @!parse - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(request_options: {}, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(request_options: {}) + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/increase/models/oauth_token.rb b/lib/increase/models/oauth_token.rb index f77e5cf39..46582d2ef 100644 --- a/lib/increase/models/oauth_token.rb +++ b/lib/increase/models/oauth_token.rb @@ -24,18 +24,14 @@ class OAuthToken < Increase::Internal::Type::BaseModel # @return [Symbol, Increase::Models::OAuthToken::Type] required :type, enum: -> { Increase::Models::OAuthToken::Type } - # @!parse - # # A token that is returned to your application when a user completes the OAuth - # # flow and may be used to authenticate requests. Learn more about OAuth - # # [here](/documentation/oauth). - # # - # # @param access_token [String] - # # @param token_type [Symbol, Increase::Models::OAuthToken::TokenType] - # # @param type [Symbol, Increase::Models::OAuthToken::Type] - # # - # def initialize(access_token:, token_type:, type:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(access_token:, token_type:, type:) + # A token that is returned to your application when a user completes the OAuth + # flow and may be used to authenticate requests. Learn more about OAuth + # [here](/documentation/oauth). + # + # @param access_token [String] + # @param token_type [Symbol, Increase::Models::OAuthToken::TokenType] + # @param type [Symbol, Increase::Models::OAuthToken::Type] # The type of OAuth token. # @@ -45,11 +41,8 @@ module TokenType BEARER = :bearer - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # A constant representing the object's type. For this resource it will always be @@ -61,11 +54,8 @@ module Type OAUTH_TOKEN = :oauth_token - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end diff --git a/lib/increase/models/oauth_token_create_params.rb b/lib/increase/models/oauth_token_create_params.rb index 18650c52e..69c22ae7d 100644 --- a/lib/increase/models/oauth_token_create_params.rb +++ b/lib/increase/models/oauth_token_create_params.rb @@ -4,8 +4,7 @@ module Increase module Models # @see Increase::Resources::OAuthTokens#create class OAuthTokenCreateParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters # @!attribute grant_type @@ -15,17 +14,13 @@ class OAuthTokenCreateParams < Increase::Internal::Type::BaseModel # @return [Symbol, Increase::Models::OAuthTokenCreateParams::GrantType] required :grant_type, enum: -> { Increase::Models::OAuthTokenCreateParams::GrantType } - # @!attribute [r] client_id + # @!attribute client_id # The public identifier for your application. # # @return [String, nil] optional :client_id, String - # @!parse - # # @return [String] - # attr_writer :client_id - - # @!attribute [r] client_secret + # @!attribute client_secret # The secret that confirms you own the application. This is redundent given that # the request is made with your API key but it's a required component of OAuth # 2.0. @@ -33,22 +28,14 @@ class OAuthTokenCreateParams < Increase::Internal::Type::BaseModel # @return [String, nil] optional :client_secret, String - # @!parse - # # @return [String] - # attr_writer :client_secret - - # @!attribute [r] code + # @!attribute code # The authorization code generated by the user and given to you as a query # parameter. # # @return [String, nil] optional :code, String - # @!parse - # # @return [String] - # attr_writer :code - - # @!attribute [r] production_token + # @!attribute production_token # The production token you want to exchange for a sandbox token. This is only # available in Sandbox. Set `grant_type` to `production_token` to use this # parameter. @@ -56,21 +43,13 @@ class OAuthTokenCreateParams < Increase::Internal::Type::BaseModel # @return [String, nil] optional :production_token, String - # @!parse - # # @return [String] - # attr_writer :production_token - - # @!parse - # # @param grant_type [Symbol, Increase::Models::OAuthTokenCreateParams::GrantType] - # # @param client_id [String] - # # @param client_secret [String] - # # @param code [String] - # # @param production_token [String] - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(grant_type:, client_id: nil, client_secret: nil, code: nil, production_token: nil, request_options: {}, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(grant_type:, client_id: nil, client_secret: nil, code: nil, production_token: nil, request_options: {}) + # @param grant_type [Symbol, Increase::Models::OAuthTokenCreateParams::GrantType] + # @param client_id [String] + # @param client_secret [String] + # @param code [String] + # @param production_token [String] + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] # The credential you request in exchange for the code. In Production, this is # always `authorization_code`. In Sandbox, you can pass either enum value. @@ -83,11 +62,8 @@ module GrantType # An OAuth production token. PRODUCTION_TOKEN = :production_token - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end diff --git a/lib/increase/models/pending_transaction.rb b/lib/increase/models/pending_transaction.rb index ce88d8f09..6b624c518 100644 --- a/lib/increase/models/pending_transaction.rb +++ b/lib/increase/models/pending_transaction.rb @@ -88,42 +88,22 @@ class PendingTransaction < Increase::Internal::Type::BaseModel # @return [Symbol, Increase::Models::PendingTransaction::Type] required :type, enum: -> { Increase::Models::PendingTransaction::Type } - # @!parse - # # Pending Transactions are potential future additions and removals of money from - # # your bank account. - # # - # # @param id [String] - # # @param account_id [String] - # # @param amount [Integer] - # # @param completed_at [Time, nil] - # # @param created_at [Time] - # # @param currency [Symbol, Increase::Models::PendingTransaction::Currency] - # # @param description [String] - # # @param route_id [String, nil] - # # @param route_type [Symbol, Increase::Models::PendingTransaction::RouteType, nil] - # # @param source [Increase::Models::PendingTransaction::Source] - # # @param status [Symbol, Increase::Models::PendingTransaction::Status] - # # @param type [Symbol, Increase::Models::PendingTransaction::Type] - # # - # def initialize( - # id:, - # account_id:, - # amount:, - # completed_at:, - # created_at:, - # currency:, - # description:, - # route_id:, - # route_type:, - # source:, - # status:, - # type:, - # ** - # ) - # super - # end - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(id:, account_id:, amount:, completed_at:, created_at:, currency:, description:, route_id:, route_type:, source:, status:, type:) + # Pending Transactions are potential future additions and removals of money from + # your bank account. + # + # @param id [String] + # @param account_id [String] + # @param amount [Integer] + # @param completed_at [Time, nil] + # @param created_at [Time] + # @param currency [Symbol, Increase::Models::PendingTransaction::Currency] + # @param description [String] + # @param route_id [String, nil] + # @param route_type [Symbol, Increase::Models::PendingTransaction::RouteType, nil] + # @param source [Increase::Models::PendingTransaction::Source] + # @param status [Symbol, Increase::Models::PendingTransaction::Status] + # @param type [Symbol, Increase::Models::PendingTransaction::Type] # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the Pending # Transaction's currency. This will match the currency on the Pending @@ -151,11 +131,8 @@ module Currency # US Dollar (USD) USD = :USD - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # The type of the route this Pending Transaction came through. @@ -173,11 +150,8 @@ module RouteType # A Lockbox. LOCKBOX = :lockbox - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Increase::Models::PendingTransaction#source @@ -284,41 +258,22 @@ class Source < Increase::Internal::Type::BaseModel -> { Increase::Models::PendingTransaction::Source::WireTransferInstruction }, nil?: true - # @!parse - # # This is an object giving more details on the network-level event that caused the - # # Pending Transaction. For example, for a card transaction this lists the - # # merchant's industry and location. - # # - # # @param account_transfer_instruction [Increase::Models::PendingTransaction::Source::AccountTransferInstruction, nil] - # # @param ach_transfer_instruction [Increase::Models::PendingTransaction::Source::ACHTransferInstruction, nil] - # # @param card_authorization [Increase::Models::PendingTransaction::Source::CardAuthorization, nil] - # # @param category [Symbol, Increase::Models::PendingTransaction::Source::Category] - # # @param check_deposit_instruction [Increase::Models::PendingTransaction::Source::CheckDepositInstruction, nil] - # # @param check_transfer_instruction [Increase::Models::PendingTransaction::Source::CheckTransferInstruction, nil] - # # @param inbound_funds_hold [Increase::Models::PendingTransaction::Source::InboundFundsHold, nil] - # # @param inbound_wire_transfer_reversal [Increase::Models::PendingTransaction::Source::InboundWireTransferReversal, nil] - # # @param other [Object, nil] - # # @param real_time_payments_transfer_instruction [Increase::Models::PendingTransaction::Source::RealTimePaymentsTransferInstruction, nil] - # # @param wire_transfer_instruction [Increase::Models::PendingTransaction::Source::WireTransferInstruction, nil] - # # - # def initialize( - # account_transfer_instruction:, - # ach_transfer_instruction:, - # card_authorization:, - # category:, - # check_deposit_instruction:, - # check_transfer_instruction:, - # inbound_funds_hold:, - # inbound_wire_transfer_reversal:, - # other:, - # real_time_payments_transfer_instruction:, - # wire_transfer_instruction:, - # ** - # ) - # super - # end - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(account_transfer_instruction:, ach_transfer_instruction:, card_authorization:, category:, check_deposit_instruction:, check_transfer_instruction:, inbound_funds_hold:, inbound_wire_transfer_reversal:, other:, real_time_payments_transfer_instruction:, wire_transfer_instruction:) + # This is an object giving more details on the network-level event that caused the + # Pending Transaction. For example, for a card transaction this lists the + # merchant's industry and location. + # + # @param account_transfer_instruction [Increase::Models::PendingTransaction::Source::AccountTransferInstruction, nil] + # @param ach_transfer_instruction [Increase::Models::PendingTransaction::Source::ACHTransferInstruction, nil] + # @param card_authorization [Increase::Models::PendingTransaction::Source::CardAuthorization, nil] + # @param category [Symbol, Increase::Models::PendingTransaction::Source::Category] + # @param check_deposit_instruction [Increase::Models::PendingTransaction::Source::CheckDepositInstruction, nil] + # @param check_transfer_instruction [Increase::Models::PendingTransaction::Source::CheckTransferInstruction, nil] + # @param inbound_funds_hold [Increase::Models::PendingTransaction::Source::InboundFundsHold, nil] + # @param inbound_wire_transfer_reversal [Increase::Models::PendingTransaction::Source::InboundWireTransferReversal, nil] + # @param other [Object, nil] + # @param real_time_payments_transfer_instruction [Increase::Models::PendingTransaction::Source::RealTimePaymentsTransferInstruction, nil] + # @param wire_transfer_instruction [Increase::Models::PendingTransaction::Source::WireTransferInstruction, nil] # @see Increase::Models::PendingTransaction::Source#account_transfer_instruction class AccountTransferInstruction < Increase::Internal::Type::BaseModel @@ -343,17 +298,13 @@ class AccountTransferInstruction < Increase::Internal::Type::BaseModel # @return [String] required :transfer_id, String - # @!parse - # # An Account Transfer Instruction object. This field will be present in the JSON - # # response if and only if `category` is equal to `account_transfer_instruction`. - # # - # # @param amount [Integer] - # # @param currency [Symbol, Increase::Models::PendingTransaction::Source::AccountTransferInstruction::Currency] - # # @param transfer_id [String] - # # - # def initialize(amount:, currency:, transfer_id:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(amount:, currency:, transfer_id:) + # An Account Transfer Instruction object. This field will be present in the JSON + # response if and only if `category` is equal to `account_transfer_instruction`. + # + # @param amount [Integer] + # @param currency [Symbol, Increase::Models::PendingTransaction::Source::AccountTransferInstruction::Currency] + # @param transfer_id [String] # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the destination # account currency. @@ -380,11 +331,8 @@ module Currency # US Dollar (USD) USD = :USD - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -402,16 +350,12 @@ class ACHTransferInstruction < Increase::Internal::Type::BaseModel # @return [String] required :transfer_id, String - # @!parse - # # An ACH Transfer Instruction object. This field will be present in the JSON - # # response if and only if `category` is equal to `ach_transfer_instruction`. - # # - # # @param amount [Integer] - # # @param transfer_id [String] - # # - # def initialize(amount:, transfer_id:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(amount:, transfer_id:) + # An ACH Transfer Instruction object. This field will be present in the JSON + # response if and only if `category` is equal to `ach_transfer_instruction`. + # + # @param amount [Integer] + # @param transfer_id [String] end # @see Increase::Models::PendingTransaction::Source#card_authorization @@ -599,74 +543,39 @@ class CardAuthorization < Increase::Internal::Type::BaseModel required :verification, -> { Increase::Models::PendingTransaction::Source::CardAuthorization::Verification } - # @!parse - # # A Card Authorization object. This field will be present in the JSON response if - # # and only if `category` is equal to `card_authorization`. Card Authorizations are - # # temporary holds placed on a customers funds with the intent to later clear a - # # transaction. - # # - # # @param id [String] - # # @param actioner [Symbol, Increase::Models::PendingTransaction::Source::CardAuthorization::Actioner] - # # @param amount [Integer] - # # @param card_payment_id [String] - # # @param currency [Symbol, Increase::Models::PendingTransaction::Source::CardAuthorization::Currency] - # # @param digital_wallet_token_id [String, nil] - # # @param direction [Symbol, Increase::Models::PendingTransaction::Source::CardAuthorization::Direction] - # # @param expires_at [Time] - # # @param merchant_acceptor_id [String] - # # @param merchant_category_code [String] - # # @param merchant_city [String, nil] - # # @param merchant_country [String] - # # @param merchant_descriptor [String] - # # @param merchant_postal_code [String, nil] - # # @param merchant_state [String, nil] - # # @param network_details [Increase::Models::PendingTransaction::Source::CardAuthorization::NetworkDetails] - # # @param network_identifiers [Increase::Models::PendingTransaction::Source::CardAuthorization::NetworkIdentifiers] - # # @param network_risk_score [Integer, nil] - # # @param pending_transaction_id [String, nil] - # # @param physical_card_id [String, nil] - # # @param presentment_amount [Integer] - # # @param presentment_currency [String] - # # @param processing_category [Symbol, Increase::Models::PendingTransaction::Source::CardAuthorization::ProcessingCategory] - # # @param real_time_decision_id [String, nil] - # # @param terminal_id [String, nil] - # # @param type [Symbol, Increase::Models::PendingTransaction::Source::CardAuthorization::Type] - # # @param verification [Increase::Models::PendingTransaction::Source::CardAuthorization::Verification] - # # - # def initialize( - # id:, - # actioner:, - # amount:, - # card_payment_id:, - # currency:, - # digital_wallet_token_id:, - # direction:, - # expires_at:, - # merchant_acceptor_id:, - # merchant_category_code:, - # merchant_city:, - # merchant_country:, - # merchant_descriptor:, - # merchant_postal_code:, - # merchant_state:, - # network_details:, - # network_identifiers:, - # network_risk_score:, - # pending_transaction_id:, - # physical_card_id:, - # presentment_amount:, - # presentment_currency:, - # processing_category:, - # real_time_decision_id:, - # terminal_id:, - # type:, - # verification:, - # ** - # ) - # super - # end - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(id:, actioner:, amount:, card_payment_id:, currency:, digital_wallet_token_id:, direction:, expires_at:, merchant_acceptor_id:, merchant_category_code:, merchant_city:, merchant_country:, merchant_descriptor:, merchant_postal_code:, merchant_state:, network_details:, network_identifiers:, network_risk_score:, pending_transaction_id:, physical_card_id:, presentment_amount:, presentment_currency:, processing_category:, real_time_decision_id:, terminal_id:, type:, verification:) + # A Card Authorization object. This field will be present in the JSON response if + # and only if `category` is equal to `card_authorization`. Card Authorizations are + # temporary holds placed on a customers funds with the intent to later clear a + # transaction. + # + # @param id [String] + # @param actioner [Symbol, Increase::Models::PendingTransaction::Source::CardAuthorization::Actioner] + # @param amount [Integer] + # @param card_payment_id [String] + # @param currency [Symbol, Increase::Models::PendingTransaction::Source::CardAuthorization::Currency] + # @param digital_wallet_token_id [String, nil] + # @param direction [Symbol, Increase::Models::PendingTransaction::Source::CardAuthorization::Direction] + # @param expires_at [Time] + # @param merchant_acceptor_id [String] + # @param merchant_category_code [String] + # @param merchant_city [String, nil] + # @param merchant_country [String] + # @param merchant_descriptor [String] + # @param merchant_postal_code [String, nil] + # @param merchant_state [String, nil] + # @param network_details [Increase::Models::PendingTransaction::Source::CardAuthorization::NetworkDetails] + # @param network_identifiers [Increase::Models::PendingTransaction::Source::CardAuthorization::NetworkIdentifiers] + # @param network_risk_score [Integer, nil] + # @param pending_transaction_id [String, nil] + # @param physical_card_id [String, nil] + # @param presentment_amount [Integer] + # @param presentment_currency [String] + # @param processing_category [Symbol, Increase::Models::PendingTransaction::Source::CardAuthorization::ProcessingCategory] + # @param real_time_decision_id [String, nil] + # @param terminal_id [String, nil] + # @param type [Symbol, Increase::Models::PendingTransaction::Source::CardAuthorization::Type] + # @param verification [Increase::Models::PendingTransaction::Source::CardAuthorization::Verification] # Whether this authorization was approved by Increase, the card network through # stand-in processing, or the user through a real-time decision. @@ -684,11 +593,8 @@ module Actioner # This object was actioned by the network, through stand-in processing. NETWORK = :network - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the @@ -716,11 +622,8 @@ module Currency # US Dollar (USD) USD = :USD - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # The direction describes the direction the funds will move, either from the @@ -736,11 +639,8 @@ module Direction # A refund card authorization, sometimes referred to as a credit voucher authorization, where funds are credited to the cardholder. REFUND = :refund - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Increase::Models::PendingTransaction::Source::CardAuthorization#network_details @@ -760,15 +660,11 @@ class NetworkDetails < Increase::Internal::Type::BaseModel -> { Increase::Models::PendingTransaction::Source::CardAuthorization::NetworkDetails::Visa }, nil?: true - # @!parse - # # Fields specific to the `network`. - # # - # # @param category [Symbol, Increase::Models::PendingTransaction::Source::CardAuthorization::NetworkDetails::Category] - # # @param visa [Increase::Models::PendingTransaction::Source::CardAuthorization::NetworkDetails::Visa, nil] - # # - # def initialize(category:, visa:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(category:, visa:) + # Fields specific to the `network`. + # + # @param category [Symbol, Increase::Models::PendingTransaction::Source::CardAuthorization::NetworkDetails::Category] + # @param visa [Increase::Models::PendingTransaction::Source::CardAuthorization::NetworkDetails::Visa, nil] # The payment network used to process this card authorization. # @@ -779,11 +675,8 @@ module Category # Visa VISA = :visa - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Increase::Models::PendingTransaction::Source::CardAuthorization::NetworkDetails#visa @@ -816,16 +709,12 @@ class Visa < Increase::Internal::Type::BaseModel enum: -> { Increase::Models::PendingTransaction::Source::CardAuthorization::NetworkDetails::Visa::StandInProcessingReason }, nil?: true - # @!parse - # # Fields specific to the `visa` network. - # # - # # @param electronic_commerce_indicator [Symbol, Increase::Models::PendingTransaction::Source::CardAuthorization::NetworkDetails::Visa::ElectronicCommerceIndicator, nil] - # # @param point_of_service_entry_mode [Symbol, Increase::Models::PendingTransaction::Source::CardAuthorization::NetworkDetails::Visa::PointOfServiceEntryMode, nil] - # # @param stand_in_processing_reason [Symbol, Increase::Models::PendingTransaction::Source::CardAuthorization::NetworkDetails::Visa::StandInProcessingReason, nil] - # # - # def initialize(electronic_commerce_indicator:, point_of_service_entry_mode:, stand_in_processing_reason:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(electronic_commerce_indicator:, point_of_service_entry_mode:, stand_in_processing_reason:) + # Fields specific to the `visa` network. + # + # @param electronic_commerce_indicator [Symbol, Increase::Models::PendingTransaction::Source::CardAuthorization::NetworkDetails::Visa::ElectronicCommerceIndicator, nil] + # @param point_of_service_entry_mode [Symbol, Increase::Models::PendingTransaction::Source::CardAuthorization::NetworkDetails::Visa::PointOfServiceEntryMode, nil] + # @param stand_in_processing_reason [Symbol, Increase::Models::PendingTransaction::Source::CardAuthorization::NetworkDetails::Visa::StandInProcessingReason, nil] # For electronic commerce transactions, this identifies the level of security used # in obtaining the customer's payment credential. For mail or telephone order @@ -860,11 +749,8 @@ module ElectronicCommerceIndicator # Non-secure transaction: Use to identify an electronic commerce transaction that has no data protection. NON_SECURE_TRANSACTION = :non_secure_transaction - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # The method used to enter the cardholder's primary account number and card @@ -904,11 +790,8 @@ module PointOfServiceEntryMode # Contact chip card, without card verification value INTEGRATED_CIRCUIT_CARD_NO_CVV = :integrated_circuit_card_no_cvv - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # Only present when `actioner: network`. Describes why a card authorization was @@ -941,11 +824,8 @@ module StandInProcessingReason # An unspecific reason for stand-in processing. OTHER = :other - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -974,16 +854,12 @@ class NetworkIdentifiers < Increase::Internal::Type::BaseModel # @return [String, nil] required :transaction_id, String, nil?: true - # @!parse - # # Network-specific identifiers for a specific request or transaction. - # # - # # @param retrieval_reference_number [String, nil] - # # @param trace_number [String, nil] - # # @param transaction_id [String, nil] - # # - # def initialize(retrieval_reference_number:, trace_number:, transaction_id:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(retrieval_reference_number:, trace_number:, transaction_id:) + # Network-specific identifiers for a specific request or transaction. + # + # @param retrieval_reference_number [String, nil] + # @param trace_number [String, nil] + # @param transaction_id [String, nil] end # The processing category describes the intent behind the authorization, such as @@ -1011,11 +887,8 @@ module ProcessingCategory # A refund card authorization, sometimes referred to as a credit voucher authorization, where funds are credited to the cardholder. REFUND = :refund - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # A constant representing the object's type. For this resource it will always be @@ -1027,11 +900,8 @@ module Type CARD_AUTHORIZATION = :card_authorization - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Increase::Models::PendingTransaction::Source::CardAuthorization#verification @@ -1052,15 +922,11 @@ class Verification < Increase::Internal::Type::BaseModel required :cardholder_address, -> { Increase::Models::PendingTransaction::Source::CardAuthorization::Verification::CardholderAddress } - # @!parse - # # Fields related to verification of cardholder-provided values. - # # - # # @param card_verification_code [Increase::Models::PendingTransaction::Source::CardAuthorization::Verification::CardVerificationCode] - # # @param cardholder_address [Increase::Models::PendingTransaction::Source::CardAuthorization::Verification::CardholderAddress] - # # - # def initialize(card_verification_code:, cardholder_address:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(card_verification_code:, cardholder_address:) + # Fields related to verification of cardholder-provided values. + # + # @param card_verification_code [Increase::Models::PendingTransaction::Source::CardAuthorization::Verification::CardVerificationCode] + # @param cardholder_address [Increase::Models::PendingTransaction::Source::CardAuthorization::Verification::CardholderAddress] # @see Increase::Models::PendingTransaction::Source::CardAuthorization::Verification#card_verification_code class CardVerificationCode < Increase::Internal::Type::BaseModel @@ -1071,15 +937,11 @@ class CardVerificationCode < Increase::Internal::Type::BaseModel required :result, enum: -> { Increase::Models::PendingTransaction::Source::CardAuthorization::Verification::CardVerificationCode::Result } - # @!parse - # # Fields related to verification of the Card Verification Code, a 3-digit code on - # # the back of the card. - # # - # # @param result [Symbol, Increase::Models::PendingTransaction::Source::CardAuthorization::Verification::CardVerificationCode::Result] - # # - # def initialize(result:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(result:) + # Fields related to verification of the Card Verification Code, a 3-digit code on + # the back of the card. + # + # @param result [Symbol, Increase::Models::PendingTransaction::Source::CardAuthorization::Verification::CardVerificationCode::Result] # The result of verifying the Card Verification Code. # @@ -1096,11 +958,8 @@ module Result # The card verification code did not match the one on file. NO_MATCH = :no_match - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -1138,19 +997,15 @@ class CardholderAddress < Increase::Internal::Type::BaseModel required :result, enum: -> { Increase::Models::PendingTransaction::Source::CardAuthorization::Verification::CardholderAddress::Result } - # @!parse - # # Cardholder address provided in the authorization request and the address on file - # # we verified it against. - # # - # # @param actual_line1 [String, nil] - # # @param actual_postal_code [String, nil] - # # @param provided_line1 [String, nil] - # # @param provided_postal_code [String, nil] - # # @param result [Symbol, Increase::Models::PendingTransaction::Source::CardAuthorization::Verification::CardholderAddress::Result] - # # - # def initialize(actual_line1:, actual_postal_code:, provided_line1:, provided_postal_code:, result:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(actual_line1:, actual_postal_code:, provided_line1:, provided_postal_code:, result:) + # Cardholder address provided in the authorization request and the address on file + # we verified it against. + # + # @param actual_line1 [String, nil] + # @param actual_postal_code [String, nil] + # @param provided_line1 [String, nil] + # @param provided_postal_code [String, nil] + # @param result [Symbol, Increase::Models::PendingTransaction::Source::CardAuthorization::Verification::CardholderAddress::Result] # The address verification result returned to the card network. # @@ -1176,11 +1031,8 @@ module Result # Postal code and street address do not match. NO_MATCH = :no_match - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -1223,11 +1075,8 @@ module Category # The Pending Transaction was made for an undocumented or deprecated reason. OTHER = :other - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Increase::Models::PendingTransaction::Source#check_deposit_instruction @@ -1266,19 +1115,15 @@ class CheckDepositInstruction < Increase::Internal::Type::BaseModel # @return [String] required :front_image_file_id, String - # @!parse - # # A Check Deposit Instruction object. This field will be present in the JSON - # # response if and only if `category` is equal to `check_deposit_instruction`. - # # - # # @param amount [Integer] - # # @param back_image_file_id [String, nil] - # # @param check_deposit_id [String, nil] - # # @param currency [Symbol, Increase::Models::PendingTransaction::Source::CheckDepositInstruction::Currency] - # # @param front_image_file_id [String] - # # - # def initialize(amount:, back_image_file_id:, check_deposit_id:, currency:, front_image_file_id:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(amount:, back_image_file_id:, check_deposit_id:, currency:, front_image_file_id:) + # A Check Deposit Instruction object. This field will be present in the JSON + # response if and only if `category` is equal to `check_deposit_instruction`. + # + # @param amount [Integer] + # @param back_image_file_id [String, nil] + # @param check_deposit_id [String, nil] + # @param currency [Symbol, Increase::Models::PendingTransaction::Source::CheckDepositInstruction::Currency] + # @param front_image_file_id [String] # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the # transaction's currency. @@ -1305,11 +1150,8 @@ module Currency # US Dollar (USD) USD = :USD - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -1335,17 +1177,13 @@ class CheckTransferInstruction < Increase::Internal::Type::BaseModel # @return [String] required :transfer_id, String - # @!parse - # # A Check Transfer Instruction object. This field will be present in the JSON - # # response if and only if `category` is equal to `check_transfer_instruction`. - # # - # # @param amount [Integer] - # # @param currency [Symbol, Increase::Models::PendingTransaction::Source::CheckTransferInstruction::Currency] - # # @param transfer_id [String] - # # - # def initialize(amount:, currency:, transfer_id:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(amount:, currency:, transfer_id:) + # A Check Transfer Instruction object. This field will be present in the JSON + # response if and only if `category` is equal to `check_transfer_instruction`. + # + # @param amount [Integer] + # @param currency [Symbol, Increase::Models::PendingTransaction::Source::CheckTransferInstruction::Currency] + # @param transfer_id [String] # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the check's # currency. @@ -1372,11 +1210,8 @@ module Currency # US Dollar (USD) USD = :USD - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -1447,40 +1282,22 @@ class InboundFundsHold < Increase::Internal::Type::BaseModel # @return [Symbol, Increase::Models::PendingTransaction::Source::InboundFundsHold::Type] required :type, enum: -> { Increase::Models::PendingTransaction::Source::InboundFundsHold::Type } - # @!parse - # # An Inbound Funds Hold object. This field will be present in the JSON response if - # # and only if `category` is equal to `inbound_funds_hold`. We hold funds for - # # certain transaction types to account for return windows where funds might still - # # be clawed back by the sending institution. - # # - # # @param id [String] - # # @param amount [Integer] - # # @param automatically_releases_at [Time] - # # @param created_at [Time] - # # @param currency [Symbol, Increase::Models::PendingTransaction::Source::InboundFundsHold::Currency] - # # @param held_transaction_id [String, nil] - # # @param pending_transaction_id [String, nil] - # # @param released_at [Time, nil] - # # @param status [Symbol, Increase::Models::PendingTransaction::Source::InboundFundsHold::Status] - # # @param type [Symbol, Increase::Models::PendingTransaction::Source::InboundFundsHold::Type] - # # - # def initialize( - # id:, - # amount:, - # automatically_releases_at:, - # created_at:, - # currency:, - # held_transaction_id:, - # pending_transaction_id:, - # released_at:, - # status:, - # type:, - # ** - # ) - # super - # end - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(id:, amount:, automatically_releases_at:, created_at:, currency:, held_transaction_id:, pending_transaction_id:, released_at:, status:, type:) + # An Inbound Funds Hold object. This field will be present in the JSON response if + # and only if `category` is equal to `inbound_funds_hold`. We hold funds for + # certain transaction types to account for return windows where funds might still + # be clawed back by the sending institution. + # + # @param id [String] + # @param amount [Integer] + # @param automatically_releases_at [Time] + # @param created_at [Time] + # @param currency [Symbol, Increase::Models::PendingTransaction::Source::InboundFundsHold::Currency] + # @param held_transaction_id [String, nil] + # @param pending_transaction_id [String, nil] + # @param released_at [Time, nil] + # @param status [Symbol, Increase::Models::PendingTransaction::Source::InboundFundsHold::Status] + # @param type [Symbol, Increase::Models::PendingTransaction::Source::InboundFundsHold::Type] # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the hold's # currency. @@ -1507,11 +1324,8 @@ module Currency # US Dollar (USD) USD = :USD - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # The status of the hold. @@ -1526,11 +1340,8 @@ module Status # Funds have been released. COMPLETE = :complete - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # A constant representing the object's type. For this resource it will always be @@ -1542,11 +1353,8 @@ module Type INBOUND_FUNDS_HOLD = :inbound_funds_hold - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -1558,17 +1366,13 @@ class InboundWireTransferReversal < Increase::Internal::Type::BaseModel # @return [String] required :inbound_wire_transfer_id, String - # @!parse - # # An Inbound Wire Transfer Reversal object. This field will be present in the JSON - # # response if and only if `category` is equal to `inbound_wire_transfer_reversal`. - # # An Inbound Wire Transfer Reversal is created when Increase has received a wire - # # and the User requests that it be reversed. - # # - # # @param inbound_wire_transfer_id [String] - # # - # def initialize(inbound_wire_transfer_id:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(inbound_wire_transfer_id:) + # An Inbound Wire Transfer Reversal object. This field will be present in the JSON + # response if and only if `category` is equal to `inbound_wire_transfer_reversal`. + # An Inbound Wire Transfer Reversal is created when Increase has received a wire + # and the User requests that it be reversed. + # + # @param inbound_wire_transfer_id [String] end # @see Increase::Models::PendingTransaction::Source#real_time_payments_transfer_instruction @@ -1586,17 +1390,13 @@ class RealTimePaymentsTransferInstruction < Increase::Internal::Type::BaseModel # @return [String] required :transfer_id, String - # @!parse - # # A Real-Time Payments Transfer Instruction object. This field will be present in - # # the JSON response if and only if `category` is equal to - # # `real_time_payments_transfer_instruction`. - # # - # # @param amount [Integer] - # # @param transfer_id [String] - # # - # def initialize(amount:, transfer_id:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(amount:, transfer_id:) + # A Real-Time Payments Transfer Instruction object. This field will be present in + # the JSON response if and only if `category` is equal to + # `real_time_payments_transfer_instruction`. + # + # @param amount [Integer] + # @param transfer_id [String] end # @see Increase::Models::PendingTransaction::Source#wire_transfer_instruction @@ -1632,19 +1432,15 @@ class WireTransferInstruction < Increase::Internal::Type::BaseModel # @return [String] required :transfer_id, String - # @!parse - # # A Wire Transfer Instruction object. This field will be present in the JSON - # # response if and only if `category` is equal to `wire_transfer_instruction`. - # # - # # @param account_number [String] - # # @param amount [Integer] - # # @param message_to_recipient [String] - # # @param routing_number [String] - # # @param transfer_id [String] - # # - # def initialize(account_number:, amount:, message_to_recipient:, routing_number:, transfer_id:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(account_number:, amount:, message_to_recipient:, routing_number:, transfer_id:) + # A Wire Transfer Instruction object. This field will be present in the JSON + # response if and only if `category` is equal to `wire_transfer_instruction`. + # + # @param account_number [String] + # @param amount [Integer] + # @param message_to_recipient [String] + # @param routing_number [String] + # @param transfer_id [String] end end @@ -1661,11 +1457,8 @@ module Status # The Pending Transaction is confirmed. An associated Transaction exists for this object. The Pending Transaction will no longer count against your balance and can generally be hidden from UIs, etc. COMPLETE = :complete - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # A constant representing the object's type. For this resource it will always be @@ -1677,11 +1470,8 @@ module Type PENDING_TRANSACTION = :pending_transaction - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end diff --git a/lib/increase/models/pending_transaction_list_params.rb b/lib/increase/models/pending_transaction_list_params.rb index bc4f006e0..d1b150c84 100644 --- a/lib/increase/models/pending_transaction_list_params.rb +++ b/lib/increase/models/pending_transaction_list_params.rb @@ -4,106 +4,61 @@ module Increase module Models # @see Increase::Resources::PendingTransactions#list class PendingTransactionListParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters - # @!attribute [r] account_id + # @!attribute account_id # Filter pending transactions to those belonging to the specified Account. # # @return [String, nil] optional :account_id, String - # @!parse - # # @return [String] - # attr_writer :account_id - - # @!attribute [r] category + # @!attribute category # # @return [Increase::Models::PendingTransactionListParams::Category, nil] optional :category, -> { Increase::Models::PendingTransactionListParams::Category } - # @!parse - # # @return [Increase::Models::PendingTransactionListParams::Category] - # attr_writer :category - - # @!attribute [r] created_at + # @!attribute created_at # # @return [Increase::Models::PendingTransactionListParams::CreatedAt, nil] optional :created_at, -> { Increase::Models::PendingTransactionListParams::CreatedAt } - # @!parse - # # @return [Increase::Models::PendingTransactionListParams::CreatedAt] - # attr_writer :created_at - - # @!attribute [r] cursor + # @!attribute cursor # Return the page of entries after this one. # # @return [String, nil] optional :cursor, String - # @!parse - # # @return [String] - # attr_writer :cursor - - # @!attribute [r] limit + # @!attribute limit # Limit the size of the list that is returned. The default (and maximum) is 100 # objects. # # @return [Integer, nil] optional :limit, Integer - # @!parse - # # @return [Integer] - # attr_writer :limit - - # @!attribute [r] route_id + # @!attribute route_id # Filter pending transactions to those belonging to the specified Route. # # @return [String, nil] optional :route_id, String - # @!parse - # # @return [String] - # attr_writer :route_id - - # @!attribute [r] status + # @!attribute status # # @return [Increase::Models::PendingTransactionListParams::Status, nil] optional :status, -> { Increase::Models::PendingTransactionListParams::Status } - # @!parse - # # @return [Increase::Models::PendingTransactionListParams::Status] - # attr_writer :status - - # @!parse - # # @param account_id [String] - # # @param category [Increase::Models::PendingTransactionListParams::Category] - # # @param created_at [Increase::Models::PendingTransactionListParams::CreatedAt] - # # @param cursor [String] - # # @param limit [Integer] - # # @param route_id [String] - # # @param status [Increase::Models::PendingTransactionListParams::Status] - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize( - # account_id: nil, - # category: nil, - # created_at: nil, - # cursor: nil, - # limit: nil, - # route_id: nil, - # status: nil, - # request_options: {}, - # ** - # ) - # super - # end - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(account_id: nil, category: nil, created_at: nil, cursor: nil, limit: nil, route_id: nil, status: nil, request_options: {}) + # @param account_id [String] + # @param category [Increase::Models::PendingTransactionListParams::Category] + # @param created_at [Increase::Models::PendingTransactionListParams::CreatedAt] + # @param cursor [String] + # @param limit [Integer] + # @param route_id [String] + # @param status [Increase::Models::PendingTransactionListParams::Status] + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] class Category < Increase::Internal::Type::BaseModel - # @!attribute [r] in_ + # @!attribute in_ # Return results whose value is in the provided list. For GET requests, this # should be encoded as a comma-delimited string, such as `?in=one,two,three`. # @@ -112,16 +67,8 @@ class Category < Increase::Internal::Type::BaseModel -> { Increase::Internal::Type::ArrayOf[enum: Increase::Models::PendingTransactionListParams::Category::In] }, api_name: :in - # @!parse - # # @return [Array] - # attr_writer :in_ - - # @!parse - # # @param in_ [Array] - # # - # def initialize(in_: nil, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(in_: nil) + # @param in_ [Array] module In extend Increase::Internal::Type::Enum @@ -156,72 +103,49 @@ module In # The Pending Transaction was made for an undocumented or deprecated reason. OTHER = :other - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end class CreatedAt < Increase::Internal::Type::BaseModel - # @!attribute [r] after + # @!attribute after # Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) # timestamp. # # @return [Time, nil] optional :after, Time - # @!parse - # # @return [Time] - # attr_writer :after - - # @!attribute [r] before + # @!attribute before # Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) # timestamp. # # @return [Time, nil] optional :before, Time - # @!parse - # # @return [Time] - # attr_writer :before - - # @!attribute [r] on_or_after + # @!attribute on_or_after # Return results on or after this # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. # # @return [Time, nil] optional :on_or_after, Time - # @!parse - # # @return [Time] - # attr_writer :on_or_after - - # @!attribute [r] on_or_before + # @!attribute on_or_before # Return results on or before this # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. # # @return [Time, nil] optional :on_or_before, Time - # @!parse - # # @return [Time] - # attr_writer :on_or_before - - # @!parse - # # @param after [Time] - # # @param before [Time] - # # @param on_or_after [Time] - # # @param on_or_before [Time] - # # - # def initialize(after: nil, before: nil, on_or_after: nil, on_or_before: nil, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(after: nil, before: nil, on_or_after: nil, on_or_before: nil) + # @param after [Time] + # @param before [Time] + # @param on_or_after [Time] + # @param on_or_before [Time] end class Status < Increase::Internal::Type::BaseModel - # @!attribute [r] in_ + # @!attribute in_ # Filter Pending Transactions for those with the specified status. By default only # Pending Transactions in with status `pending` will be returned. For GET # requests, this should be encoded as a comma-delimited string, such as @@ -232,16 +156,8 @@ class Status < Increase::Internal::Type::BaseModel -> { Increase::Internal::Type::ArrayOf[enum: Increase::Models::PendingTransactionListParams::Status::In] }, api_name: :in - # @!parse - # # @return [Array] - # attr_writer :in_ - - # @!parse - # # @param in_ [Array] - # # - # def initialize(in_: nil, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(in_: nil) + # @param in_ [Array] module In extend Increase::Internal::Type::Enum @@ -252,11 +168,8 @@ module In # The Pending Transaction is confirmed. An associated Transaction exists for this object. The Pending Transaction will no longer count against your balance and can generally be hidden from UIs, etc. COMPLETE = :complete - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end diff --git a/lib/increase/models/pending_transaction_retrieve_params.rb b/lib/increase/models/pending_transaction_retrieve_params.rb index b1fc3a02a..ff9a5e657 100644 --- a/lib/increase/models/pending_transaction_retrieve_params.rb +++ b/lib/increase/models/pending_transaction_retrieve_params.rb @@ -4,16 +4,11 @@ module Increase module Models # @see Increase::Resources::PendingTransactions#retrieve class PendingTransactionRetrieveParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters - # @!parse - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(request_options: {}, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(request_options: {}) + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/increase/models/physical_card.rb b/lib/increase/models/physical_card.rb index 142aec700..d16447fb7 100644 --- a/lib/increase/models/physical_card.rb +++ b/lib/increase/models/physical_card.rb @@ -62,39 +62,22 @@ class PhysicalCard < Increase::Internal::Type::BaseModel # @return [Symbol, Increase::Models::PhysicalCard::Type] required :type, enum: -> { Increase::Models::PhysicalCard::Type } - # @!parse - # # Custom physical Visa cards that are shipped to your customers. The artwork is - # # configurable by a connected [Card Profile](/documentation/api#card-profiles). - # # The same Card can be used for multiple Physical Cards. Printing cards incurs a - # # fee. Please contact [support@increase.com](mailto:support@increase.com) for - # # pricing! - # # - # # @param id [String] - # # @param card_id [String] - # # @param cardholder [Increase::Models::PhysicalCard::Cardholder] - # # @param created_at [Time] - # # @param idempotency_key [String, nil] - # # @param physical_card_profile_id [String, nil] - # # @param shipment [Increase::Models::PhysicalCard::Shipment] - # # @param status [Symbol, Increase::Models::PhysicalCard::Status] - # # @param type [Symbol, Increase::Models::PhysicalCard::Type] - # # - # def initialize( - # id:, - # card_id:, - # cardholder:, - # created_at:, - # idempotency_key:, - # physical_card_profile_id:, - # shipment:, - # status:, - # type:, - # ** - # ) - # super - # end - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(id:, card_id:, cardholder:, created_at:, idempotency_key:, physical_card_profile_id:, shipment:, status:, type:) + # Custom physical Visa cards that are shipped to your customers. The artwork is + # configurable by a connected [Card Profile](/documentation/api#card-profiles). + # The same Card can be used for multiple Physical Cards. Printing cards incurs a + # fee. Please contact [support@increase.com](mailto:support@increase.com) for + # pricing! + # + # @param id [String] + # @param card_id [String] + # @param cardholder [Increase::Models::PhysicalCard::Cardholder] + # @param created_at [Time] + # @param idempotency_key [String, nil] + # @param physical_card_profile_id [String, nil] + # @param shipment [Increase::Models::PhysicalCard::Shipment] + # @param status [Symbol, Increase::Models::PhysicalCard::Status] + # @param type [Symbol, Increase::Models::PhysicalCard::Type] # @see Increase::Models::PhysicalCard#cardholder class Cardholder < Increase::Internal::Type::BaseModel @@ -110,15 +93,11 @@ class Cardholder < Increase::Internal::Type::BaseModel # @return [String] required :last_name, String - # @!parse - # # Details about the cardholder, as it appears on the printed card. - # # - # # @param first_name [String] - # # @param last_name [String] - # # - # def initialize(first_name:, last_name:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(first_name:, last_name:) + # Details about the cardholder, as it appears on the printed card. + # + # @param first_name [String] + # @param last_name [String] end # @see Increase::Models::PhysicalCard#shipment @@ -147,17 +126,13 @@ class Shipment < Increase::Internal::Type::BaseModel # @return [Increase::Models::PhysicalCard::Shipment::Tracking, nil] required :tracking, -> { Increase::Models::PhysicalCard::Shipment::Tracking }, nil?: true - # @!parse - # # The details used to ship this physical card. - # # - # # @param address [Increase::Models::PhysicalCard::Shipment::Address] - # # @param method_ [Symbol, Increase::Models::PhysicalCard::Shipment::Method] - # # @param status [Symbol, Increase::Models::PhysicalCard::Shipment::Status] - # # @param tracking [Increase::Models::PhysicalCard::Shipment::Tracking, nil] - # # - # def initialize(address:, method_:, status:, tracking:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(address:, method_:, status:, tracking:) + # The details used to ship this physical card. + # + # @param address [Increase::Models::PhysicalCard::Shipment::Address] + # @param method_ [Symbol, Increase::Models::PhysicalCard::Shipment::Method] + # @param status [Symbol, Increase::Models::PhysicalCard::Shipment::Status] + # @param tracking [Increase::Models::PhysicalCard::Shipment::Tracking, nil] # @see Increase::Models::PhysicalCard::Shipment#address class Address < Increase::Internal::Type::BaseModel @@ -203,20 +178,16 @@ class Address < Increase::Internal::Type::BaseModel # @return [String] required :state, String - # @!parse - # # The location to where the card's packing label is addressed. - # # - # # @param city [String] - # # @param line1 [String] - # # @param line2 [String, nil] - # # @param line3 [String, nil] - # # @param name [String] - # # @param postal_code [String] - # # @param state [String] - # # - # def initialize(city:, line1:, line2:, line3:, name:, postal_code:, state:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(city:, line1:, line2:, line3:, name:, postal_code:, state:) + # The location to where the card's packing label is addressed. + # + # @param city [String] + # @param line1 [String] + # @param line2 [String, nil] + # @param line3 [String, nil] + # @param name [String] + # @param postal_code [String] + # @param state [String] end # The shipping method. @@ -234,11 +205,8 @@ module Method # FedEx 2-day. FEDEX_2_DAY = :fedex_2_day - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # The status of this shipment. @@ -268,11 +236,8 @@ module Status # The physical card shipment was returned to the sender and destroyed by the production facility. RETURNED = :returned - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Increase::Models::PhysicalCard::Shipment#tracking @@ -303,17 +268,13 @@ class Tracking < Increase::Internal::Type::BaseModel # @return [Time] required :shipped_at, Time - # @!parse - # # Tracking details for the shipment. - # # - # # @param number [String] - # # @param return_number [String, nil] - # # @param return_reason [String, nil] - # # @param shipped_at [Time] - # # - # def initialize(number:, return_number:, return_reason:, shipped_at:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(number:, return_number:, return_reason:, shipped_at:) + # Tracking details for the shipment. + # + # @param number [String] + # @param return_number [String, nil] + # @param return_reason [String, nil] + # @param shipped_at [Time] end end @@ -332,11 +293,8 @@ module Status # The physical card is permanently canceled. CANCELED = :canceled - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # A constant representing the object's type. For this resource it will always be @@ -348,11 +306,8 @@ module Type PHYSICAL_CARD = :physical_card - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end diff --git a/lib/increase/models/physical_card_create_params.rb b/lib/increase/models/physical_card_create_params.rb index 99488cb8c..2bf63fde6 100644 --- a/lib/increase/models/physical_card_create_params.rb +++ b/lib/increase/models/physical_card_create_params.rb @@ -4,8 +4,7 @@ module Increase module Models # @see Increase::Resources::PhysicalCards#create class PhysicalCardCreateParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters # @!attribute card_id @@ -26,27 +25,19 @@ class PhysicalCardCreateParams < Increase::Internal::Type::BaseModel # @return [Increase::Models::PhysicalCardCreateParams::Shipment] required :shipment, -> { Increase::Models::PhysicalCardCreateParams::Shipment } - # @!attribute [r] physical_card_profile_id + # @!attribute physical_card_profile_id # The physical card profile to use for this physical card. The latest default # physical card profile will be used if not provided. # # @return [String, nil] optional :physical_card_profile_id, String - # @!parse - # # @return [String] - # attr_writer :physical_card_profile_id - - # @!parse - # # @param card_id [String] - # # @param cardholder [Increase::Models::PhysicalCardCreateParams::Cardholder] - # # @param shipment [Increase::Models::PhysicalCardCreateParams::Shipment] - # # @param physical_card_profile_id [String] - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(card_id:, cardholder:, shipment:, physical_card_profile_id: nil, request_options: {}, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(card_id:, cardholder:, shipment:, physical_card_profile_id: nil, request_options: {}) + # @param card_id [String] + # @param cardholder [Increase::Models::PhysicalCardCreateParams::Cardholder] + # @param shipment [Increase::Models::PhysicalCardCreateParams::Shipment] + # @param physical_card_profile_id [String] + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] class Cardholder < Increase::Internal::Type::BaseModel # @!attribute first_name @@ -61,15 +52,11 @@ class Cardholder < Increase::Internal::Type::BaseModel # @return [String] required :last_name, String - # @!parse - # # Details about the cardholder, as it will appear on the physical card. - # # - # # @param first_name [String] - # # @param last_name [String] - # # - # def initialize(first_name:, last_name:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(first_name:, last_name:) + # Details about the cardholder, as it will appear on the physical card. + # + # @param first_name [String] + # @param last_name [String] end class Shipment < Increase::Internal::Type::BaseModel @@ -87,15 +74,11 @@ class Shipment < Increase::Internal::Type::BaseModel enum: -> { Increase::Models::PhysicalCardCreateParams::Shipment::Method }, api_name: :method - # @!parse - # # The details used to ship this physical card. - # # - # # @param address [Increase::Models::PhysicalCardCreateParams::Shipment::Address] - # # @param method_ [Symbol, Increase::Models::PhysicalCardCreateParams::Shipment::Method] - # # - # def initialize(address:, method_:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(address:, method_:) + # The details used to ship this physical card. + # + # @param address [Increase::Models::PhysicalCardCreateParams::Shipment::Address] + # @param method_ [Symbol, Increase::Models::PhysicalCardCreateParams::Shipment::Method] # @see Increase::Models::PhysicalCardCreateParams::Shipment#address class Address < Increase::Internal::Type::BaseModel @@ -129,51 +112,35 @@ class Address < Increase::Internal::Type::BaseModel # @return [String] required :state, String - # @!attribute [r] line2 + # @!attribute line2 # The second line of the shipping address. # # @return [String, nil] optional :line2, String - # @!parse - # # @return [String] - # attr_writer :line2 - - # @!attribute [r] line3 + # @!attribute line3 # The third line of the shipping address. # # @return [String, nil] optional :line3, String - # @!parse - # # @return [String] - # attr_writer :line3 - - # @!attribute [r] phone_number + # @!attribute phone_number # The phone number of the recipient. # # @return [String, nil] optional :phone_number, String - # @!parse - # # @return [String] - # attr_writer :phone_number - - # @!parse - # # The address to where the card should be shipped. - # # - # # @param city [String] - # # @param line1 [String] - # # @param name [String] - # # @param postal_code [String] - # # @param state [String] - # # @param line2 [String] - # # @param line3 [String] - # # @param phone_number [String] - # # - # def initialize(city:, line1:, name:, postal_code:, state:, line2: nil, line3: nil, phone_number: nil, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(city:, line1:, name:, postal_code:, state:, line2: nil, line3: nil, phone_number: nil) + # The address to where the card should be shipped. + # + # @param city [String] + # @param line1 [String] + # @param name [String] + # @param postal_code [String] + # @param state [String] + # @param line2 [String] + # @param line3 [String] + # @param phone_number [String] end # The shipping method to use. @@ -191,11 +158,8 @@ module Method # FedEx 2-day. FEDEX_2_DAY = :fedex_2_day - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end diff --git a/lib/increase/models/physical_card_list_params.rb b/lib/increase/models/physical_card_list_params.rb index efdc80d7f..3ead222f9 100644 --- a/lib/increase/models/physical_card_list_params.rb +++ b/lib/increase/models/physical_card_list_params.rb @@ -4,40 +4,27 @@ module Increase module Models # @see Increase::Resources::PhysicalCards#list class PhysicalCardListParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters - # @!attribute [r] card_id + # @!attribute card_id # Filter Physical Cards to ones belonging to the specified Card. # # @return [String, nil] optional :card_id, String - # @!parse - # # @return [String] - # attr_writer :card_id - - # @!attribute [r] created_at + # @!attribute created_at # # @return [Increase::Models::PhysicalCardListParams::CreatedAt, nil] optional :created_at, -> { Increase::Models::PhysicalCardListParams::CreatedAt } - # @!parse - # # @return [Increase::Models::PhysicalCardListParams::CreatedAt] - # attr_writer :created_at - - # @!attribute [r] cursor + # @!attribute cursor # Return the page of entries after this one. # # @return [String, nil] optional :cursor, String - # @!parse - # # @return [String] - # attr_writer :cursor - - # @!attribute [r] idempotency_key + # @!attribute idempotency_key # Filter records to the one with the specified `idempotency_key` you chose for # that object. This value is unique across Increase and is used to ensure that a # request is only processed once. Learn more about @@ -46,87 +33,55 @@ class PhysicalCardListParams < Increase::Internal::Type::BaseModel # @return [String, nil] optional :idempotency_key, String - # @!parse - # # @return [String] - # attr_writer :idempotency_key - - # @!attribute [r] limit + # @!attribute limit # Limit the size of the list that is returned. The default (and maximum) is 100 # objects. # # @return [Integer, nil] optional :limit, Integer - # @!parse - # # @return [Integer] - # attr_writer :limit - - # @!parse - # # @param card_id [String] - # # @param created_at [Increase::Models::PhysicalCardListParams::CreatedAt] - # # @param cursor [String] - # # @param idempotency_key [String] - # # @param limit [Integer] - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(card_id: nil, created_at: nil, cursor: nil, idempotency_key: nil, limit: nil, request_options: {}, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(card_id: nil, created_at: nil, cursor: nil, idempotency_key: nil, limit: nil, request_options: {}) + # @param card_id [String] + # @param created_at [Increase::Models::PhysicalCardListParams::CreatedAt] + # @param cursor [String] + # @param idempotency_key [String] + # @param limit [Integer] + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] class CreatedAt < Increase::Internal::Type::BaseModel - # @!attribute [r] after + # @!attribute after # Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) # timestamp. # # @return [Time, nil] optional :after, Time - # @!parse - # # @return [Time] - # attr_writer :after - - # @!attribute [r] before + # @!attribute before # Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) # timestamp. # # @return [Time, nil] optional :before, Time - # @!parse - # # @return [Time] - # attr_writer :before - - # @!attribute [r] on_or_after + # @!attribute on_or_after # Return results on or after this # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. # # @return [Time, nil] optional :on_or_after, Time - # @!parse - # # @return [Time] - # attr_writer :on_or_after - - # @!attribute [r] on_or_before + # @!attribute on_or_before # Return results on or before this # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. # # @return [Time, nil] optional :on_or_before, Time - # @!parse - # # @return [Time] - # attr_writer :on_or_before - - # @!parse - # # @param after [Time] - # # @param before [Time] - # # @param on_or_after [Time] - # # @param on_or_before [Time] - # # - # def initialize(after: nil, before: nil, on_or_after: nil, on_or_before: nil, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(after: nil, before: nil, on_or_after: nil, on_or_before: nil) + # @param after [Time] + # @param before [Time] + # @param on_or_after [Time] + # @param on_or_before [Time] end end end diff --git a/lib/increase/models/physical_card_profile.rb b/lib/increase/models/physical_card_profile.rb index fa2db323f..a853959bc 100644 --- a/lib/increase/models/physical_card_profile.rb +++ b/lib/increase/models/physical_card_profile.rb @@ -87,45 +87,24 @@ class PhysicalCardProfile < Increase::Internal::Type::BaseModel # @return [Symbol, Increase::Models::PhysicalCardProfile::Type] required :type, enum: -> { Increase::Models::PhysicalCardProfile::Type } - # @!parse - # # This contains artwork and metadata relating to a Physical Card's appearance. For - # # more information, see our guide on - # # [physical card artwork](https://increase.com/documentation/card-art-physical-cards). - # # - # # @param id [String] - # # @param back_image_file_id [String, nil] - # # @param carrier_image_file_id [String, nil] - # # @param contact_phone [String, nil] - # # @param created_at [Time] - # # @param creator [Symbol, Increase::Models::PhysicalCardProfile::Creator] - # # @param description [String] - # # @param front_image_file_id [String, nil] - # # @param idempotency_key [String, nil] - # # @param is_default [Boolean] - # # @param program_id [String] - # # @param status [Symbol, Increase::Models::PhysicalCardProfile::Status] - # # @param type [Symbol, Increase::Models::PhysicalCardProfile::Type] - # # - # def initialize( - # id:, - # back_image_file_id:, - # carrier_image_file_id:, - # contact_phone:, - # created_at:, - # creator:, - # description:, - # front_image_file_id:, - # idempotency_key:, - # is_default:, - # program_id:, - # status:, - # type:, - # ** - # ) - # super - # end - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(id:, back_image_file_id:, carrier_image_file_id:, contact_phone:, created_at:, creator:, description:, front_image_file_id:, idempotency_key:, is_default:, program_id:, status:, type:) + # This contains artwork and metadata relating to a Physical Card's appearance. For + # more information, see our guide on + # [physical card artwork](https://increase.com/documentation/card-art-physical-cards). + # + # @param id [String] + # @param back_image_file_id [String, nil] + # @param carrier_image_file_id [String, nil] + # @param contact_phone [String, nil] + # @param created_at [Time] + # @param creator [Symbol, Increase::Models::PhysicalCardProfile::Creator] + # @param description [String] + # @param front_image_file_id [String, nil] + # @param idempotency_key [String, nil] + # @param is_default [Boolean] + # @param program_id [String] + # @param status [Symbol, Increase::Models::PhysicalCardProfile::Status] + # @param type [Symbol, Increase::Models::PhysicalCardProfile::Type] # The creator of this Physical Card Profile. # @@ -139,11 +118,8 @@ module Creator # This Physical Card Profile was created by you. USER = :user - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # The status of the Physical Card Profile. @@ -170,11 +146,8 @@ module Status # The Physical Card Profile has been archived. ARCHIVED = :archived - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # A constant representing the object's type. For this resource it will always be @@ -186,11 +159,8 @@ module Type PHYSICAL_CARD_PROFILE = :physical_card_profile - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end diff --git a/lib/increase/models/physical_card_profile_archive_params.rb b/lib/increase/models/physical_card_profile_archive_params.rb index ee334ef24..8a02d298b 100644 --- a/lib/increase/models/physical_card_profile_archive_params.rb +++ b/lib/increase/models/physical_card_profile_archive_params.rb @@ -4,16 +4,11 @@ module Increase module Models # @see Increase::Resources::PhysicalCardProfiles#archive class PhysicalCardProfileArchiveParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters - # @!parse - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(request_options: {}, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(request_options: {}) + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/increase/models/physical_card_profile_clone_params.rb b/lib/increase/models/physical_card_profile_clone_params.rb index 70b125a6b..28193c6d8 100644 --- a/lib/increase/models/physical_card_profile_clone_params.rb +++ b/lib/increase/models/physical_card_profile_clone_params.rb @@ -4,82 +4,47 @@ module Increase module Models # @see Increase::Resources::PhysicalCardProfiles#clone_ class PhysicalCardProfileCloneParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters - # @!attribute [r] carrier_image_file_id + # @!attribute carrier_image_file_id # The identifier of the File containing the physical card's carrier image. # # @return [String, nil] optional :carrier_image_file_id, String - # @!parse - # # @return [String] - # attr_writer :carrier_image_file_id - - # @!attribute [r] contact_phone + # @!attribute contact_phone # A phone number the user can contact to receive support for their card. # # @return [String, nil] optional :contact_phone, String - # @!parse - # # @return [String] - # attr_writer :contact_phone - - # @!attribute [r] description + # @!attribute description # A description you can use to identify the Card Profile. # # @return [String, nil] optional :description, String - # @!parse - # # @return [String] - # attr_writer :description - - # @!attribute [r] front_image_file_id + # @!attribute front_image_file_id # The identifier of the File containing the physical card's front image. # # @return [String, nil] optional :front_image_file_id, String - # @!parse - # # @return [String] - # attr_writer :front_image_file_id - - # @!attribute [r] front_text + # @!attribute front_text # Text printed on the front of the card. Reach out to # [support@increase.com](mailto:support@increase.com) for more information. # # @return [Increase::Models::PhysicalCardProfileCloneParams::FrontText, nil] optional :front_text, -> { Increase::Models::PhysicalCardProfileCloneParams::FrontText } - # @!parse - # # @return [Increase::Models::PhysicalCardProfileCloneParams::FrontText] - # attr_writer :front_text - - # @!parse - # # @param carrier_image_file_id [String] - # # @param contact_phone [String] - # # @param description [String] - # # @param front_image_file_id [String] - # # @param front_text [Increase::Models::PhysicalCardProfileCloneParams::FrontText] - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize( - # carrier_image_file_id: nil, - # contact_phone: nil, - # description: nil, - # front_image_file_id: nil, - # front_text: nil, - # request_options: {}, - # ** - # ) - # super - # end - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(carrier_image_file_id: nil, contact_phone: nil, description: nil, front_image_file_id: nil, front_text: nil, request_options: {}) + # @param carrier_image_file_id [String] + # @param contact_phone [String] + # @param description [String] + # @param front_image_file_id [String] + # @param front_text [Increase::Models::PhysicalCardProfileCloneParams::FrontText] + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] class FrontText < Increase::Internal::Type::BaseModel # @!attribute line1 @@ -88,7 +53,7 @@ class FrontText < Increase::Internal::Type::BaseModel # @return [String] required :line1, String - # @!attribute [r] line2 + # @!attribute line2 # The second line of text on the front of the card. Providing a second line moves # the first line slightly higher and prints the second line in the spot where the # first line would have otherwise been printed. @@ -96,20 +61,12 @@ class FrontText < Increase::Internal::Type::BaseModel # @return [String, nil] optional :line2, String - # @!parse - # # @return [String] - # attr_writer :line2 - - # @!parse - # # Text printed on the front of the card. Reach out to - # # [support@increase.com](mailto:support@increase.com) for more information. - # # - # # @param line1 [String] - # # @param line2 [String] - # # - # def initialize(line1:, line2: nil, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(line1:, line2: nil) + # Text printed on the front of the card. Reach out to + # [support@increase.com](mailto:support@increase.com) for more information. + # + # @param line1 [String] + # @param line2 [String] end end end diff --git a/lib/increase/models/physical_card_profile_create_params.rb b/lib/increase/models/physical_card_profile_create_params.rb index cf29d30a3..9e158409f 100644 --- a/lib/increase/models/physical_card_profile_create_params.rb +++ b/lib/increase/models/physical_card_profile_create_params.rb @@ -4,8 +4,7 @@ module Increase module Models # @see Increase::Resources::PhysicalCardProfiles#create class PhysicalCardProfileCreateParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters # @!attribute carrier_image_file_id @@ -38,27 +37,13 @@ class PhysicalCardProfileCreateParams < Increase::Internal::Type::BaseModel # @return [String] required :program_id, String - # @!parse - # # @param carrier_image_file_id [String] - # # @param contact_phone [String] - # # @param description [String] - # # @param front_image_file_id [String] - # # @param program_id [String] - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize( - # carrier_image_file_id:, - # contact_phone:, - # description:, - # front_image_file_id:, - # program_id:, - # request_options: {}, - # ** - # ) - # super - # end - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(carrier_image_file_id:, contact_phone:, description:, front_image_file_id:, program_id:, request_options: {}) + # @param carrier_image_file_id [String] + # @param contact_phone [String] + # @param description [String] + # @param front_image_file_id [String] + # @param program_id [String] + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/increase/models/physical_card_profile_list_params.rb b/lib/increase/models/physical_card_profile_list_params.rb index 4183c07fc..17b522f09 100644 --- a/lib/increase/models/physical_card_profile_list_params.rb +++ b/lib/increase/models/physical_card_profile_list_params.rb @@ -4,21 +4,16 @@ module Increase module Models # @see Increase::Resources::PhysicalCardProfiles#list class PhysicalCardProfileListParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters - # @!attribute [r] cursor + # @!attribute cursor # Return the page of entries after this one. # # @return [String, nil] optional :cursor, String - # @!parse - # # @return [String] - # attr_writer :cursor - - # @!attribute [r] idempotency_key + # @!attribute idempotency_key # Filter records to the one with the specified `idempotency_key` you chose for # that object. This value is unique across Increase and is used to ensure that a # request is only processed once. Learn more about @@ -27,43 +22,27 @@ class PhysicalCardProfileListParams < Increase::Internal::Type::BaseModel # @return [String, nil] optional :idempotency_key, String - # @!parse - # # @return [String] - # attr_writer :idempotency_key - - # @!attribute [r] limit + # @!attribute limit # Limit the size of the list that is returned. The default (and maximum) is 100 # objects. # # @return [Integer, nil] optional :limit, Integer - # @!parse - # # @return [Integer] - # attr_writer :limit - - # @!attribute [r] status + # @!attribute status # # @return [Increase::Models::PhysicalCardProfileListParams::Status, nil] optional :status, -> { Increase::Models::PhysicalCardProfileListParams::Status } - # @!parse - # # @return [Increase::Models::PhysicalCardProfileListParams::Status] - # attr_writer :status - - # @!parse - # # @param cursor [String] - # # @param idempotency_key [String] - # # @param limit [Integer] - # # @param status [Increase::Models::PhysicalCardProfileListParams::Status] - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(cursor: nil, idempotency_key: nil, limit: nil, status: nil, request_options: {}, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(cursor: nil, idempotency_key: nil, limit: nil, status: nil, request_options: {}) + # @param cursor [String] + # @param idempotency_key [String] + # @param limit [Integer] + # @param status [Increase::Models::PhysicalCardProfileListParams::Status] + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] class Status < Increase::Internal::Type::BaseModel - # @!attribute [r] in_ + # @!attribute in_ # Filter Physical Card Profiles for those with the specified statuses. For GET # requests, this should be encoded as a comma-delimited string, such as # `?in=one,two,three`. @@ -73,16 +52,8 @@ class Status < Increase::Internal::Type::BaseModel -> { Increase::Internal::Type::ArrayOf[enum: Increase::Models::PhysicalCardProfileListParams::Status::In] }, api_name: :in - # @!parse - # # @return [Array] - # attr_writer :in_ - - # @!parse - # # @param in_ [Array] - # # - # def initialize(in_: nil, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(in_: nil) + # @param in_ [Array] module In extend Increase::Internal::Type::Enum @@ -105,11 +76,8 @@ module In # The Physical Card Profile has been archived. ARCHIVED = :archived - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end diff --git a/lib/increase/models/physical_card_profile_retrieve_params.rb b/lib/increase/models/physical_card_profile_retrieve_params.rb index caff38adc..4e6eb097f 100644 --- a/lib/increase/models/physical_card_profile_retrieve_params.rb +++ b/lib/increase/models/physical_card_profile_retrieve_params.rb @@ -4,16 +4,11 @@ module Increase module Models # @see Increase::Resources::PhysicalCardProfiles#retrieve class PhysicalCardProfileRetrieveParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters - # @!parse - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(request_options: {}, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(request_options: {}) + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/increase/models/physical_card_retrieve_params.rb b/lib/increase/models/physical_card_retrieve_params.rb index cbd654678..dea3b3db0 100644 --- a/lib/increase/models/physical_card_retrieve_params.rb +++ b/lib/increase/models/physical_card_retrieve_params.rb @@ -4,16 +4,11 @@ module Increase module Models # @see Increase::Resources::PhysicalCards#retrieve class PhysicalCardRetrieveParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters - # @!parse - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(request_options: {}, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(request_options: {}) + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/increase/models/physical_card_update_params.rb b/lib/increase/models/physical_card_update_params.rb index 9f2c486ad..47b9ed7f2 100644 --- a/lib/increase/models/physical_card_update_params.rb +++ b/lib/increase/models/physical_card_update_params.rb @@ -4,8 +4,7 @@ module Increase module Models # @see Increase::Resources::PhysicalCards#update class PhysicalCardUpdateParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters # @!attribute status @@ -14,13 +13,9 @@ class PhysicalCardUpdateParams < Increase::Internal::Type::BaseModel # @return [Symbol, Increase::Models::PhysicalCardUpdateParams::Status] required :status, enum: -> { Increase::Models::PhysicalCardUpdateParams::Status } - # @!parse - # # @param status [Symbol, Increase::Models::PhysicalCardUpdateParams::Status] - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(status:, request_options: {}, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(status:, request_options: {}) + # @param status [Symbol, Increase::Models::PhysicalCardUpdateParams::Status] + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] # The status to update the Physical Card to. module Status @@ -35,11 +30,8 @@ module Status # The physical card is permanently canceled. CANCELED = :canceled - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end diff --git a/lib/increase/models/program.rb b/lib/increase/models/program.rb index ebe7191ee..bcb43fc7e 100644 --- a/lib/increase/models/program.rb +++ b/lib/increase/models/program.rb @@ -63,38 +63,21 @@ class Program < Increase::Internal::Type::BaseModel # @return [Time] required :updated_at, Time - # @!parse - # # Programs determine the compliance and commercial terms of Accounts. By default, - # # you have a Commercial Banking program for managing your own funds. If you are - # # lending or managing funds on behalf of your customers, or otherwise engaged in - # # regulated activity, we will work together to create additional Programs for you. - # # - # # @param id [String] - # # @param bank [Symbol, Increase::Models::Program::Bank] - # # @param billing_account_id [String, nil] - # # @param created_at [Time] - # # @param default_digital_card_profile_id [String, nil] - # # @param interest_rate [String] - # # @param name [String] - # # @param type [Symbol, Increase::Models::Program::Type] - # # @param updated_at [Time] - # # - # def initialize( - # id:, - # bank:, - # billing_account_id:, - # created_at:, - # default_digital_card_profile_id:, - # interest_rate:, - # name:, - # type:, - # updated_at:, - # ** - # ) - # super - # end - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(id:, bank:, billing_account_id:, created_at:, default_digital_card_profile_id:, interest_rate:, name:, type:, updated_at:) + # Programs determine the compliance and commercial terms of Accounts. By default, + # you have a Commercial Banking program for managing your own funds. If you are + # lending or managing funds on behalf of your customers, or otherwise engaged in + # regulated activity, we will work together to create additional Programs for you. + # + # @param id [String] + # @param bank [Symbol, Increase::Models::Program::Bank] + # @param billing_account_id [String, nil] + # @param created_at [Time] + # @param default_digital_card_profile_id [String, nil] + # @param interest_rate [String] + # @param name [String] + # @param type [Symbol, Increase::Models::Program::Type] + # @param updated_at [Time] # The Bank the Program is with. # @@ -111,11 +94,8 @@ module Bank # Grasshopper Bank GRASSHOPPER_BANK = :grasshopper_bank - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # A constant representing the object's type. For this resource it will always be @@ -127,11 +107,8 @@ module Type PROGRAM = :program - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end diff --git a/lib/increase/models/program_list_params.rb b/lib/increase/models/program_list_params.rb index 6a4069ea9..d2605151c 100644 --- a/lib/increase/models/program_list_params.rb +++ b/lib/increase/models/program_list_params.rb @@ -4,39 +4,26 @@ module Increase module Models # @see Increase::Resources::Programs#list class ProgramListParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters - # @!attribute [r] cursor + # @!attribute cursor # Return the page of entries after this one. # # @return [String, nil] optional :cursor, String - # @!parse - # # @return [String] - # attr_writer :cursor - - # @!attribute [r] limit + # @!attribute limit # Limit the size of the list that is returned. The default (and maximum) is 100 # objects. # # @return [Integer, nil] optional :limit, Integer - # @!parse - # # @return [Integer] - # attr_writer :limit - - # @!parse - # # @param cursor [String] - # # @param limit [Integer] - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(cursor: nil, limit: nil, request_options: {}, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(cursor: nil, limit: nil, request_options: {}) + # @param cursor [String] + # @param limit [Integer] + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/increase/models/program_retrieve_params.rb b/lib/increase/models/program_retrieve_params.rb index 58c12c288..88bda03d2 100644 --- a/lib/increase/models/program_retrieve_params.rb +++ b/lib/increase/models/program_retrieve_params.rb @@ -4,16 +4,11 @@ module Increase module Models # @see Increase::Resources::Programs#retrieve class ProgramRetrieveParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters - # @!parse - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(request_options: {}, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(request_options: {}) + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/increase/models/proof_of_authorization_request.rb b/lib/increase/models/proof_of_authorization_request.rb index cce15d655..c806ecca0 100644 --- a/lib/increase/models/proof_of_authorization_request.rb +++ b/lib/increase/models/proof_of_authorization_request.rb @@ -42,19 +42,15 @@ class ProofOfAuthorizationRequest < Increase::Internal::Type::BaseModel # @return [Time] required :updated_at, Time - # @!parse - # # A request for proof of authorization for one or more ACH debit transfers. - # # - # # @param id [String] - # # @param ach_transfers [Array] - # # @param created_at [Time] - # # @param due_on [Time] - # # @param type [Symbol, Increase::Models::ProofOfAuthorizationRequest::Type] - # # @param updated_at [Time] - # # - # def initialize(id:, ach_transfers:, created_at:, due_on:, type:, updated_at:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(id:, ach_transfers:, created_at:, due_on:, type:, updated_at:) + # A request for proof of authorization for one or more ACH debit transfers. + # + # @param id [String] + # @param ach_transfers [Array] + # @param created_at [Time] + # @param due_on [Time] + # @param type [Symbol, Increase::Models::ProofOfAuthorizationRequest::Type] + # @param updated_at [Time] class ACHTransfer < Increase::Internal::Type::BaseModel # @!attribute id @@ -63,12 +59,8 @@ class ACHTransfer < Increase::Internal::Type::BaseModel # @return [String] required :id, String - # @!parse - # # @param id [String] - # # - # def initialize(id:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(id:) + # @param id [String] end # A constant representing the object's type. For this resource it will always be @@ -80,11 +72,8 @@ module Type PROOF_OF_AUTHORIZATION_REQUEST = :proof_of_authorization_request - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end diff --git a/lib/increase/models/proof_of_authorization_request_list_params.rb b/lib/increase/models/proof_of_authorization_request_list_params.rb index 9640013ad..285b5e0e0 100644 --- a/lib/increase/models/proof_of_authorization_request_list_params.rb +++ b/lib/increase/models/proof_of_authorization_request_list_params.rb @@ -4,104 +4,67 @@ module Increase module Models # @see Increase::Resources::ProofOfAuthorizationRequests#list class ProofOfAuthorizationRequestListParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters - # @!attribute [r] created_at + # @!attribute created_at # # @return [Increase::Models::ProofOfAuthorizationRequestListParams::CreatedAt, nil] optional :created_at, -> { Increase::Models::ProofOfAuthorizationRequestListParams::CreatedAt } - # @!parse - # # @return [Increase::Models::ProofOfAuthorizationRequestListParams::CreatedAt] - # attr_writer :created_at - - # @!attribute [r] cursor + # @!attribute cursor # Return the page of entries after this one. # # @return [String, nil] optional :cursor, String - # @!parse - # # @return [String] - # attr_writer :cursor - - # @!attribute [r] limit + # @!attribute limit # Limit the size of the list that is returned. The default (and maximum) is 100 # objects. # # @return [Integer, nil] optional :limit, Integer - # @!parse - # # @return [Integer] - # attr_writer :limit - - # @!parse - # # @param created_at [Increase::Models::ProofOfAuthorizationRequestListParams::CreatedAt] - # # @param cursor [String] - # # @param limit [Integer] - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(created_at: nil, cursor: nil, limit: nil, request_options: {}, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(created_at: nil, cursor: nil, limit: nil, request_options: {}) + # @param created_at [Increase::Models::ProofOfAuthorizationRequestListParams::CreatedAt] + # @param cursor [String] + # @param limit [Integer] + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] class CreatedAt < Increase::Internal::Type::BaseModel - # @!attribute [r] after + # @!attribute after # Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) # timestamp. # # @return [Time, nil] optional :after, Time - # @!parse - # # @return [Time] - # attr_writer :after - - # @!attribute [r] before + # @!attribute before # Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) # timestamp. # # @return [Time, nil] optional :before, Time - # @!parse - # # @return [Time] - # attr_writer :before - - # @!attribute [r] on_or_after + # @!attribute on_or_after # Return results on or after this # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. # # @return [Time, nil] optional :on_or_after, Time - # @!parse - # # @return [Time] - # attr_writer :on_or_after - - # @!attribute [r] on_or_before + # @!attribute on_or_before # Return results on or before this # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. # # @return [Time, nil] optional :on_or_before, Time - # @!parse - # # @return [Time] - # attr_writer :on_or_before - - # @!parse - # # @param after [Time] - # # @param before [Time] - # # @param on_or_after [Time] - # # @param on_or_before [Time] - # # - # def initialize(after: nil, before: nil, on_or_after: nil, on_or_before: nil, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(after: nil, before: nil, on_or_after: nil, on_or_before: nil) + # @param after [Time] + # @param before [Time] + # @param on_or_after [Time] + # @param on_or_before [Time] end end end diff --git a/lib/increase/models/proof_of_authorization_request_retrieve_params.rb b/lib/increase/models/proof_of_authorization_request_retrieve_params.rb index 6bbfbf8dc..429ff879b 100644 --- a/lib/increase/models/proof_of_authorization_request_retrieve_params.rb +++ b/lib/increase/models/proof_of_authorization_request_retrieve_params.rb @@ -4,16 +4,11 @@ module Increase module Models # @see Increase::Resources::ProofOfAuthorizationRequests#retrieve class ProofOfAuthorizationRequestRetrieveParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters - # @!parse - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(request_options: {}, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(request_options: {}) + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/increase/models/proof_of_authorization_request_submission.rb b/lib/increase/models/proof_of_authorization_request_submission.rb index ab912830e..23f88f743 100644 --- a/lib/increase/models/proof_of_authorization_request_submission.rb +++ b/lib/increase/models/proof_of_authorization_request_submission.rb @@ -10,11 +10,12 @@ class ProofOfAuthorizationRequestSubmission < Increase::Internal::Type::BaseMode # @return [String] required :id, String - # @!attribute additional_evidence_file_id - # File containing additional evidence. + # @!attribute additional_evidence_files + # Files containing additional evidence. # - # @return [String, nil] - required :additional_evidence_file_id, String, nil?: true + # @return [Array] + required :additional_evidence_files, + -> { Increase::Internal::Type::ArrayOf[Increase::Models::ProofOfAuthorizationRequestSubmission::AdditionalEvidenceFile] } # @!attribute authorization_terms # Terms of authorization. @@ -117,57 +118,42 @@ class ProofOfAuthorizationRequestSubmission < Increase::Internal::Type::BaseMode # @return [Boolean, nil] required :validated_account_ownership_with_microdeposit, Increase::Internal::Type::Boolean, nil?: true - # @!parse - # # Information submitted in response to a proof of authorization request. Per - # # Nacha's guidance on proof of authorization, the originator must ensure that the - # # authorization complies with applicable legal requirements, is readily - # # identifiable as an authorization, and has clear and readily understandable - # # terms. - # # - # # @param id [String] - # # @param additional_evidence_file_id [String, nil] - # # @param authorization_terms [String] - # # @param authorized_at [Time] - # # @param authorizer_company [String, nil] - # # @param authorizer_email [String, nil] - # # @param authorizer_ip_address [String, nil] - # # @param authorizer_name [String, nil] - # # @param created_at [Time] - # # @param customer_has_been_offboarded [Boolean, nil] - # # @param idempotency_key [String, nil] - # # @param proof_of_authorization_request_id [String] - # # @param status [Symbol, Increase::Models::ProofOfAuthorizationRequestSubmission::Status] - # # @param type [Symbol, Increase::Models::ProofOfAuthorizationRequestSubmission::Type] - # # @param updated_at [Time] - # # @param validated_account_ownership_via_credential [Boolean, nil] - # # @param validated_account_ownership_with_account_statement [Boolean, nil] - # # @param validated_account_ownership_with_microdeposit [Boolean, nil] - # # - # def initialize( - # id:, - # additional_evidence_file_id:, - # authorization_terms:, - # authorized_at:, - # authorizer_company:, - # authorizer_email:, - # authorizer_ip_address:, - # authorizer_name:, - # created_at:, - # customer_has_been_offboarded:, - # idempotency_key:, - # proof_of_authorization_request_id:, - # status:, - # type:, - # updated_at:, - # validated_account_ownership_via_credential:, - # validated_account_ownership_with_account_statement:, - # validated_account_ownership_with_microdeposit:, - # ** - # ) - # super - # end - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(id:, additional_evidence_files:, authorization_terms:, authorized_at:, authorizer_company:, authorizer_email:, authorizer_ip_address:, authorizer_name:, created_at:, customer_has_been_offboarded:, idempotency_key:, proof_of_authorization_request_id:, status:, type:, updated_at:, validated_account_ownership_via_credential:, validated_account_ownership_with_account_statement:, validated_account_ownership_with_microdeposit:) + # Information submitted in response to a proof of authorization request. Per + # Nacha's guidance on proof of authorization, the originator must ensure that the + # authorization complies with applicable legal requirements, is readily + # identifiable as an authorization, and has clear and readily understandable + # terms. + # + # @param id [String] + # @param additional_evidence_files [Array] + # @param authorization_terms [String] + # @param authorized_at [Time] + # @param authorizer_company [String, nil] + # @param authorizer_email [String, nil] + # @param authorizer_ip_address [String, nil] + # @param authorizer_name [String, nil] + # @param created_at [Time] + # @param customer_has_been_offboarded [Boolean, nil] + # @param idempotency_key [String, nil] + # @param proof_of_authorization_request_id [String] + # @param status [Symbol, Increase::Models::ProofOfAuthorizationRequestSubmission::Status] + # @param type [Symbol, Increase::Models::ProofOfAuthorizationRequestSubmission::Type] + # @param updated_at [Time] + # @param validated_account_ownership_via_credential [Boolean, nil] + # @param validated_account_ownership_with_account_statement [Boolean, nil] + # @param validated_account_ownership_with_microdeposit [Boolean, nil] + + class AdditionalEvidenceFile < Increase::Internal::Type::BaseModel + # @!attribute file_id + # The File identifier. + # + # @return [String] + required :file_id, String + + # @!method initialize(file_id:) + # @param file_id [String] + end # Status of the proof of authorization request submission. # @@ -190,11 +176,8 @@ module Status # The proof of authorization request submission was sent. SENT = :sent - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # A constant representing the object's type. For this resource it will always be @@ -206,11 +189,8 @@ module Type PROOF_OF_AUTHORIZATION_REQUEST_SUBMISSION = :proof_of_authorization_request_submission - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end diff --git a/lib/increase/models/proof_of_authorization_request_submission_create_params.rb b/lib/increase/models/proof_of_authorization_request_submission_create_params.rb index c7c4f377a..3237a074d 100644 --- a/lib/increase/models/proof_of_authorization_request_submission_create_params.rb +++ b/lib/increase/models/proof_of_authorization_request_submission_create_params.rb @@ -4,8 +4,7 @@ module Increase module Models # @see Increase::Resources::ProofOfAuthorizationRequestSubmissions#create class ProofOfAuthorizationRequestSubmissionCreateParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters # @!attribute authorization_terms @@ -62,71 +61,38 @@ class ProofOfAuthorizationRequestSubmissionCreateParams < Increase::Internal::Ty # @return [Boolean] required :validated_account_ownership_with_microdeposit, Increase::Internal::Type::Boolean - # @!attribute [r] additional_evidence_file_id + # @!attribute additional_evidence_file_id # File containing additional evidence. # # @return [String, nil] optional :additional_evidence_file_id, String - # @!parse - # # @return [String] - # attr_writer :additional_evidence_file_id - - # @!attribute [r] authorizer_company + # @!attribute authorizer_company # Company of the authorizer. # # @return [String, nil] optional :authorizer_company, String - # @!parse - # # @return [String] - # attr_writer :authorizer_company - - # @!attribute [r] authorizer_ip_address + # @!attribute authorizer_ip_address # IP address of the authorizer. # # @return [String, nil] optional :authorizer_ip_address, String - # @!parse - # # @return [String] - # attr_writer :authorizer_ip_address - - # @!parse - # # @param authorization_terms [String] - # # @param authorized_at [Time] - # # @param authorizer_email [String] - # # @param authorizer_name [String] - # # @param customer_has_been_offboarded [Boolean] - # # @param proof_of_authorization_request_id [String] - # # @param validated_account_ownership_via_credential [Boolean] - # # @param validated_account_ownership_with_account_statement [Boolean] - # # @param validated_account_ownership_with_microdeposit [Boolean] - # # @param additional_evidence_file_id [String] - # # @param authorizer_company [String] - # # @param authorizer_ip_address [String] - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize( - # authorization_terms:, - # authorized_at:, - # authorizer_email:, - # authorizer_name:, - # customer_has_been_offboarded:, - # proof_of_authorization_request_id:, - # validated_account_ownership_via_credential:, - # validated_account_ownership_with_account_statement:, - # validated_account_ownership_with_microdeposit:, - # additional_evidence_file_id: nil, - # authorizer_company: nil, - # authorizer_ip_address: nil, - # request_options: {}, - # ** - # ) - # super - # end - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(authorization_terms:, authorized_at:, authorizer_email:, authorizer_name:, customer_has_been_offboarded:, proof_of_authorization_request_id:, validated_account_ownership_via_credential:, validated_account_ownership_with_account_statement:, validated_account_ownership_with_microdeposit:, additional_evidence_file_id: nil, authorizer_company: nil, authorizer_ip_address: nil, request_options: {}) + # @param authorization_terms [String] + # @param authorized_at [Time] + # @param authorizer_email [String] + # @param authorizer_name [String] + # @param customer_has_been_offboarded [Boolean] + # @param proof_of_authorization_request_id [String] + # @param validated_account_ownership_via_credential [Boolean] + # @param validated_account_ownership_with_account_statement [Boolean] + # @param validated_account_ownership_with_microdeposit [Boolean] + # @param additional_evidence_file_id [String] + # @param authorizer_company [String] + # @param authorizer_ip_address [String] + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/increase/models/proof_of_authorization_request_submission_list_params.rb b/lib/increase/models/proof_of_authorization_request_submission_list_params.rb index f3f36ded8..04fff3394 100644 --- a/lib/increase/models/proof_of_authorization_request_submission_list_params.rb +++ b/lib/increase/models/proof_of_authorization_request_submission_list_params.rb @@ -4,21 +4,16 @@ module Increase module Models # @see Increase::Resources::ProofOfAuthorizationRequestSubmissions#list class ProofOfAuthorizationRequestSubmissionListParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters - # @!attribute [r] cursor + # @!attribute cursor # Return the page of entries after this one. # # @return [String, nil] optional :cursor, String - # @!parse - # # @return [String] - # attr_writer :cursor - - # @!attribute [r] idempotency_key + # @!attribute idempotency_key # Filter records to the one with the specified `idempotency_key` you chose for # that object. This value is unique across Increase and is used to ensure that a # request is only processed once. Learn more about @@ -27,50 +22,25 @@ class ProofOfAuthorizationRequestSubmissionListParams < Increase::Internal::Type # @return [String, nil] optional :idempotency_key, String - # @!parse - # # @return [String] - # attr_writer :idempotency_key - - # @!attribute [r] limit + # @!attribute limit # Limit the size of the list that is returned. The default (and maximum) is 100 # objects. # # @return [Integer, nil] optional :limit, Integer - # @!parse - # # @return [Integer] - # attr_writer :limit - - # @!attribute [r] proof_of_authorization_request_id + # @!attribute proof_of_authorization_request_id # ID of the proof of authorization request. # # @return [String, nil] optional :proof_of_authorization_request_id, String - # @!parse - # # @return [String] - # attr_writer :proof_of_authorization_request_id - - # @!parse - # # @param cursor [String] - # # @param idempotency_key [String] - # # @param limit [Integer] - # # @param proof_of_authorization_request_id [String] - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize( - # cursor: nil, - # idempotency_key: nil, - # limit: nil, - # proof_of_authorization_request_id: nil, - # request_options: {}, - # ** - # ) - # super - # end - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(cursor: nil, idempotency_key: nil, limit: nil, proof_of_authorization_request_id: nil, request_options: {}) + # @param cursor [String] + # @param idempotency_key [String] + # @param limit [Integer] + # @param proof_of_authorization_request_id [String] + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/increase/models/proof_of_authorization_request_submission_retrieve_params.rb b/lib/increase/models/proof_of_authorization_request_submission_retrieve_params.rb index 7a81fb1c9..6219b0cf0 100644 --- a/lib/increase/models/proof_of_authorization_request_submission_retrieve_params.rb +++ b/lib/increase/models/proof_of_authorization_request_submission_retrieve_params.rb @@ -4,16 +4,11 @@ module Increase module Models # @see Increase::Resources::ProofOfAuthorizationRequestSubmissions#retrieve class ProofOfAuthorizationRequestSubmissionRetrieveParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters - # @!parse - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(request_options: {}, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(request_options: {}) + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/increase/models/real_time_decision.rb b/lib/increase/models/real_time_decision.rb index e1756ee67..c34cb8935 100644 --- a/lib/increase/models/real_time_decision.rb +++ b/lib/increase/models/real_time_decision.rb @@ -77,42 +77,23 @@ class RealTimeDecision < Increase::Internal::Type::BaseModel # @return [Symbol, Increase::Models::RealTimeDecision::Type] required :type, enum: -> { Increase::Models::RealTimeDecision::Type } - # @!parse - # # Real Time Decisions are created when your application needs to take action in - # # real-time to some event such as a card authorization. For more information, see - # # our - # # [Real-Time Decisions guide](https://increase.com/documentation/real-time-decisions). - # # - # # @param id [String] - # # @param card_authentication [Increase::Models::RealTimeDecision::CardAuthentication, nil] - # # @param card_authentication_challenge [Increase::Models::RealTimeDecision::CardAuthenticationChallenge, nil] - # # @param card_authorization [Increase::Models::RealTimeDecision::CardAuthorization, nil] - # # @param category [Symbol, Increase::Models::RealTimeDecision::Category] - # # @param created_at [Time] - # # @param digital_wallet_authentication [Increase::Models::RealTimeDecision::DigitalWalletAuthentication, nil] - # # @param digital_wallet_token [Increase::Models::RealTimeDecision::DigitalWalletToken, nil] - # # @param status [Symbol, Increase::Models::RealTimeDecision::Status] - # # @param timeout_at [Time] - # # @param type [Symbol, Increase::Models::RealTimeDecision::Type] - # # - # def initialize( - # id:, - # card_authentication:, - # card_authentication_challenge:, - # card_authorization:, - # category:, - # created_at:, - # digital_wallet_authentication:, - # digital_wallet_token:, - # status:, - # timeout_at:, - # type:, - # ** - # ) - # super - # end - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(id:, card_authentication:, card_authentication_challenge:, card_authorization:, category:, created_at:, digital_wallet_authentication:, digital_wallet_token:, status:, timeout_at:, type:) + # Real Time Decisions are created when your application needs to take action in + # real-time to some event such as a card authorization. For more information, see + # our + # [Real-Time Decisions guide](https://increase.com/documentation/real-time-decisions). + # + # @param id [String] + # @param card_authentication [Increase::Models::RealTimeDecision::CardAuthentication, nil] + # @param card_authentication_challenge [Increase::Models::RealTimeDecision::CardAuthenticationChallenge, nil] + # @param card_authorization [Increase::Models::RealTimeDecision::CardAuthorization, nil] + # @param category [Symbol, Increase::Models::RealTimeDecision::Category] + # @param created_at [Time] + # @param digital_wallet_authentication [Increase::Models::RealTimeDecision::DigitalWalletAuthentication, nil] + # @param digital_wallet_token [Increase::Models::RealTimeDecision::DigitalWalletToken, nil] + # @param status [Symbol, Increase::Models::RealTimeDecision::Status] + # @param timeout_at [Time] + # @param type [Symbol, Increase::Models::RealTimeDecision::Type] # @see Increase::Models::RealTimeDecision#card_authentication class CardAuthentication < Increase::Internal::Type::BaseModel @@ -143,17 +124,13 @@ class CardAuthentication < Increase::Internal::Type::BaseModel # @return [String] required :upcoming_card_payment_id, String - # @!parse - # # Fields related to a 3DS authentication attempt. - # # - # # @param account_id [String] - # # @param card_id [String] - # # @param decision [Symbol, Increase::Models::RealTimeDecision::CardAuthentication::Decision, nil] - # # @param upcoming_card_payment_id [String] - # # - # def initialize(account_id:, card_id:, decision:, upcoming_card_payment_id:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(account_id:, card_id:, decision:, upcoming_card_payment_id:) + # Fields related to a 3DS authentication attempt. + # + # @param account_id [String] + # @param card_id [String] + # @param decision [Symbol, Increase::Models::RealTimeDecision::CardAuthentication::Decision, nil] + # @param upcoming_card_payment_id [String] # Whether or not the authentication attempt was approved. # @@ -170,11 +147,8 @@ module Decision # Deny the authentication attempt. DENY = :deny - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -213,18 +187,14 @@ class CardAuthenticationChallenge < Increase::Internal::Type::BaseModel enum: -> { Increase::Models::RealTimeDecision::CardAuthenticationChallenge::Result }, nil?: true - # @!parse - # # Fields related to a 3DS authentication attempt. - # # - # # @param account_id [String] - # # @param card_id [String] - # # @param card_payment_id [String] - # # @param one_time_code [String] - # # @param result [Symbol, Increase::Models::RealTimeDecision::CardAuthenticationChallenge::Result, nil] - # # - # def initialize(account_id:, card_id:, card_payment_id:, one_time_code:, result:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(account_id:, card_id:, card_payment_id:, one_time_code:, result:) + # Fields related to a 3DS authentication attempt. + # + # @param account_id [String] + # @param card_id [String] + # @param card_payment_id [String] + # @param one_time_code [String] + # @param result [Symbol, Increase::Models::RealTimeDecision::CardAuthenticationChallenge::Result, nil] # Whether or not the challenge was delivered to the cardholder. # @@ -238,11 +208,8 @@ module Result # Your application was unable to deliver the one-time code to the cardholder. FAILURE = :failure - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -417,67 +384,34 @@ class CardAuthorization < Increase::Internal::Type::BaseModel # @return [Increase::Models::RealTimeDecision::CardAuthorization::Verification] required :verification, -> { Increase::Models::RealTimeDecision::CardAuthorization::Verification } - # @!parse - # # Fields related to a card authorization. - # # - # # @param account_id [String] - # # @param card_id [String] - # # @param decision [Symbol, Increase::Models::RealTimeDecision::CardAuthorization::Decision, nil] - # # @param digital_wallet_token_id [String, nil] - # # @param direction [Symbol, Increase::Models::RealTimeDecision::CardAuthorization::Direction] - # # @param merchant_acceptor_id [String] - # # @param merchant_category_code [String] - # # @param merchant_city [String, nil] - # # @param merchant_country [String] - # # @param merchant_descriptor [String] - # # @param merchant_postal_code [String, nil] - # # @param merchant_state [String, nil] - # # @param network_details [Increase::Models::RealTimeDecision::CardAuthorization::NetworkDetails] - # # @param network_identifiers [Increase::Models::RealTimeDecision::CardAuthorization::NetworkIdentifiers] - # # @param network_risk_score [Integer, nil] - # # @param physical_card_id [String, nil] - # # @param presentment_amount [Integer] - # # @param presentment_currency [String] - # # @param processing_category [Symbol, Increase::Models::RealTimeDecision::CardAuthorization::ProcessingCategory] - # # @param request_details [Increase::Models::RealTimeDecision::CardAuthorization::RequestDetails] - # # @param settlement_amount [Integer] - # # @param settlement_currency [String] - # # @param terminal_id [String, nil] - # # @param upcoming_card_payment_id [String] - # # @param verification [Increase::Models::RealTimeDecision::CardAuthorization::Verification] - # # - # def initialize( - # account_id:, - # card_id:, - # decision:, - # digital_wallet_token_id:, - # direction:, - # merchant_acceptor_id:, - # merchant_category_code:, - # merchant_city:, - # merchant_country:, - # merchant_descriptor:, - # merchant_postal_code:, - # merchant_state:, - # network_details:, - # network_identifiers:, - # network_risk_score:, - # physical_card_id:, - # presentment_amount:, - # presentment_currency:, - # processing_category:, - # request_details:, - # settlement_amount:, - # settlement_currency:, - # terminal_id:, - # upcoming_card_payment_id:, - # verification:, - # ** - # ) - # super - # end - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(account_id:, card_id:, decision:, digital_wallet_token_id:, direction:, merchant_acceptor_id:, merchant_category_code:, merchant_city:, merchant_country:, merchant_descriptor:, merchant_postal_code:, merchant_state:, network_details:, network_identifiers:, network_risk_score:, physical_card_id:, presentment_amount:, presentment_currency:, processing_category:, request_details:, settlement_amount:, settlement_currency:, terminal_id:, upcoming_card_payment_id:, verification:) + # Fields related to a card authorization. + # + # @param account_id [String] + # @param card_id [String] + # @param decision [Symbol, Increase::Models::RealTimeDecision::CardAuthorization::Decision, nil] + # @param digital_wallet_token_id [String, nil] + # @param direction [Symbol, Increase::Models::RealTimeDecision::CardAuthorization::Direction] + # @param merchant_acceptor_id [String] + # @param merchant_category_code [String] + # @param merchant_city [String, nil] + # @param merchant_country [String] + # @param merchant_descriptor [String] + # @param merchant_postal_code [String, nil] + # @param merchant_state [String, nil] + # @param network_details [Increase::Models::RealTimeDecision::CardAuthorization::NetworkDetails] + # @param network_identifiers [Increase::Models::RealTimeDecision::CardAuthorization::NetworkIdentifiers] + # @param network_risk_score [Integer, nil] + # @param physical_card_id [String, nil] + # @param presentment_amount [Integer] + # @param presentment_currency [String] + # @param processing_category [Symbol, Increase::Models::RealTimeDecision::CardAuthorization::ProcessingCategory] + # @param request_details [Increase::Models::RealTimeDecision::CardAuthorization::RequestDetails] + # @param settlement_amount [Integer] + # @param settlement_currency [String] + # @param terminal_id [String, nil] + # @param upcoming_card_payment_id [String] + # @param verification [Increase::Models::RealTimeDecision::CardAuthorization::Verification] # Whether or not the authorization was approved. # @@ -491,11 +425,8 @@ module Decision # Decline the authorization. DECLINE = :decline - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # The direction describes the direction the funds will move, either from the @@ -511,11 +442,8 @@ module Direction # A refund card authorization, sometimes referred to as a credit voucher authorization, where funds are credited to the cardholder. REFUND = :refund - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Increase::Models::RealTimeDecision::CardAuthorization#network_details @@ -535,15 +463,11 @@ class NetworkDetails < Increase::Internal::Type::BaseModel -> { Increase::Models::RealTimeDecision::CardAuthorization::NetworkDetails::Visa }, nil?: true - # @!parse - # # Fields specific to the `network`. - # # - # # @param category [Symbol, Increase::Models::RealTimeDecision::CardAuthorization::NetworkDetails::Category] - # # @param visa [Increase::Models::RealTimeDecision::CardAuthorization::NetworkDetails::Visa, nil] - # # - # def initialize(category:, visa:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(category:, visa:) + # Fields specific to the `network`. + # + # @param category [Symbol, Increase::Models::RealTimeDecision::CardAuthorization::NetworkDetails::Category] + # @param visa [Increase::Models::RealTimeDecision::CardAuthorization::NetworkDetails::Visa, nil] # The payment network used to process this card authorization. # @@ -554,11 +478,8 @@ module Category # Visa VISA = :visa - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Increase::Models::RealTimeDecision::CardAuthorization::NetworkDetails#visa @@ -591,16 +512,12 @@ class Visa < Increase::Internal::Type::BaseModel enum: -> { Increase::Models::RealTimeDecision::CardAuthorization::NetworkDetails::Visa::StandInProcessingReason }, nil?: true - # @!parse - # # Fields specific to the `visa` network. - # # - # # @param electronic_commerce_indicator [Symbol, Increase::Models::RealTimeDecision::CardAuthorization::NetworkDetails::Visa::ElectronicCommerceIndicator, nil] - # # @param point_of_service_entry_mode [Symbol, Increase::Models::RealTimeDecision::CardAuthorization::NetworkDetails::Visa::PointOfServiceEntryMode, nil] - # # @param stand_in_processing_reason [Symbol, Increase::Models::RealTimeDecision::CardAuthorization::NetworkDetails::Visa::StandInProcessingReason, nil] - # # - # def initialize(electronic_commerce_indicator:, point_of_service_entry_mode:, stand_in_processing_reason:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(electronic_commerce_indicator:, point_of_service_entry_mode:, stand_in_processing_reason:) + # Fields specific to the `visa` network. + # + # @param electronic_commerce_indicator [Symbol, Increase::Models::RealTimeDecision::CardAuthorization::NetworkDetails::Visa::ElectronicCommerceIndicator, nil] + # @param point_of_service_entry_mode [Symbol, Increase::Models::RealTimeDecision::CardAuthorization::NetworkDetails::Visa::PointOfServiceEntryMode, nil] + # @param stand_in_processing_reason [Symbol, Increase::Models::RealTimeDecision::CardAuthorization::NetworkDetails::Visa::StandInProcessingReason, nil] # For electronic commerce transactions, this identifies the level of security used # in obtaining the customer's payment credential. For mail or telephone order @@ -635,11 +552,8 @@ module ElectronicCommerceIndicator # Non-secure transaction: Use to identify an electronic commerce transaction that has no data protection. NON_SECURE_TRANSACTION = :non_secure_transaction - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # The method used to enter the cardholder's primary account number and card @@ -679,11 +593,8 @@ module PointOfServiceEntryMode # Contact chip card, without card verification value INTEGRATED_CIRCUIT_CARD_NO_CVV = :integrated_circuit_card_no_cvv - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # Only present when `actioner: network`. Describes why a card authorization was @@ -716,11 +627,8 @@ module StandInProcessingReason # An unspecific reason for stand-in processing. OTHER = :other - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -749,16 +657,12 @@ class NetworkIdentifiers < Increase::Internal::Type::BaseModel # @return [String, nil] required :transaction_id, String, nil?: true - # @!parse - # # Network-specific identifiers for a specific request or transaction. - # # - # # @param retrieval_reference_number [String, nil] - # # @param trace_number [String, nil] - # # @param transaction_id [String, nil] - # # - # def initialize(retrieval_reference_number:, trace_number:, transaction_id:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(retrieval_reference_number:, trace_number:, transaction_id:) + # Network-specific identifiers for a specific request or transaction. + # + # @param retrieval_reference_number [String, nil] + # @param trace_number [String, nil] + # @param transaction_id [String, nil] end # The processing category describes the intent behind the authorization, such as @@ -786,11 +690,8 @@ module ProcessingCategory # A refund card authorization, sometimes referred to as a credit voucher authorization, where funds are credited to the cardholder. REFUND = :refund - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Increase::Models::RealTimeDecision::CardAuthorization#request_details @@ -817,16 +718,12 @@ class RequestDetails < Increase::Internal::Type::BaseModel # @return [Object, nil] required :initial_authorization, Increase::Internal::Type::Unknown, nil?: true - # @!parse - # # Fields specific to the type of request, such as an incremental authorization. - # # - # # @param category [Symbol, Increase::Models::RealTimeDecision::CardAuthorization::RequestDetails::Category] - # # @param incremental_authorization [Increase::Models::RealTimeDecision::CardAuthorization::RequestDetails::IncrementalAuthorization, nil] - # # @param initial_authorization [Object, nil] - # # - # def initialize(category:, incremental_authorization:, initial_authorization:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(category:, incremental_authorization:, initial_authorization:) + # Fields specific to the type of request, such as an incremental authorization. + # + # @param category [Symbol, Increase::Models::RealTimeDecision::CardAuthorization::RequestDetails::Category] + # @param incremental_authorization [Increase::Models::RealTimeDecision::CardAuthorization::RequestDetails::IncrementalAuthorization, nil] + # @param initial_authorization [Object, nil] # The type of this request (e.g., an initial authorization or an incremental # authorization). @@ -841,11 +738,8 @@ module Category # An incremental request to increase the amount of an existing authorization. INCREMENTAL_AUTHORIZATION = :incremental_authorization - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Increase::Models::RealTimeDecision::CardAuthorization::RequestDetails#incremental_authorization @@ -863,15 +757,11 @@ class IncrementalAuthorization < Increase::Internal::Type::BaseModel # @return [String] required :original_card_authorization_id, String - # @!parse - # # Fields specific to the category `incremental_authorization`. - # # - # # @param card_payment_id [String] - # # @param original_card_authorization_id [String] - # # - # def initialize(card_payment_id:, original_card_authorization_id:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(card_payment_id:, original_card_authorization_id:) + # Fields specific to the category `incremental_authorization`. + # + # @param card_payment_id [String] + # @param original_card_authorization_id [String] end end @@ -893,15 +783,11 @@ class Verification < Increase::Internal::Type::BaseModel required :cardholder_address, -> { Increase::Models::RealTimeDecision::CardAuthorization::Verification::CardholderAddress } - # @!parse - # # Fields related to verification of cardholder-provided values. - # # - # # @param card_verification_code [Increase::Models::RealTimeDecision::CardAuthorization::Verification::CardVerificationCode] - # # @param cardholder_address [Increase::Models::RealTimeDecision::CardAuthorization::Verification::CardholderAddress] - # # - # def initialize(card_verification_code:, cardholder_address:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(card_verification_code:, cardholder_address:) + # Fields related to verification of cardholder-provided values. + # + # @param card_verification_code [Increase::Models::RealTimeDecision::CardAuthorization::Verification::CardVerificationCode] + # @param cardholder_address [Increase::Models::RealTimeDecision::CardAuthorization::Verification::CardholderAddress] # @see Increase::Models::RealTimeDecision::CardAuthorization::Verification#card_verification_code class CardVerificationCode < Increase::Internal::Type::BaseModel @@ -912,15 +798,11 @@ class CardVerificationCode < Increase::Internal::Type::BaseModel required :result, enum: -> { Increase::Models::RealTimeDecision::CardAuthorization::Verification::CardVerificationCode::Result } - # @!parse - # # Fields related to verification of the Card Verification Code, a 3-digit code on - # # the back of the card. - # # - # # @param result [Symbol, Increase::Models::RealTimeDecision::CardAuthorization::Verification::CardVerificationCode::Result] - # # - # def initialize(result:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(result:) + # Fields related to verification of the Card Verification Code, a 3-digit code on + # the back of the card. + # + # @param result [Symbol, Increase::Models::RealTimeDecision::CardAuthorization::Verification::CardVerificationCode::Result] # The result of verifying the Card Verification Code. # @@ -937,11 +819,8 @@ module Result # The card verification code did not match the one on file. NO_MATCH = :no_match - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -979,19 +858,15 @@ class CardholderAddress < Increase::Internal::Type::BaseModel required :result, enum: -> { Increase::Models::RealTimeDecision::CardAuthorization::Verification::CardholderAddress::Result } - # @!parse - # # Cardholder address provided in the authorization request and the address on file - # # we verified it against. - # # - # # @param actual_line1 [String, nil] - # # @param actual_postal_code [String, nil] - # # @param provided_line1 [String, nil] - # # @param provided_postal_code [String, nil] - # # @param result [Symbol, Increase::Models::RealTimeDecision::CardAuthorization::Verification::CardholderAddress::Result] - # # - # def initialize(actual_line1:, actual_postal_code:, provided_line1:, provided_postal_code:, result:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(actual_line1:, actual_postal_code:, provided_line1:, provided_postal_code:, result:) + # Cardholder address provided in the authorization request and the address on file + # we verified it against. + # + # @param actual_line1 [String, nil] + # @param actual_postal_code [String, nil] + # @param provided_line1 [String, nil] + # @param provided_postal_code [String, nil] + # @param result [Symbol, Increase::Models::RealTimeDecision::CardAuthorization::Verification::CardholderAddress::Result] # The address verification result returned to the card network. # @@ -1017,11 +892,8 @@ module Result # Postal code and street address do not match. NO_MATCH = :no_match - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -1048,11 +920,8 @@ module Category # A card is being loaded into a digital wallet and requires cardholder authentication. DIGITAL_WALLET_AUTHENTICATION_REQUESTED = :digital_wallet_authentication_requested - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Increase::Models::RealTimeDecision#digital_wallet_authentication @@ -1103,20 +972,16 @@ class DigitalWalletAuthentication < Increase::Internal::Type::BaseModel enum: -> { Increase::Models::RealTimeDecision::DigitalWalletAuthentication::Result }, nil?: true - # @!parse - # # Fields related to a digital wallet authentication attempt. - # # - # # @param card_id [String] - # # @param channel [Symbol, Increase::Models::RealTimeDecision::DigitalWalletAuthentication::Channel] - # # @param digital_wallet [Symbol, Increase::Models::RealTimeDecision::DigitalWalletAuthentication::DigitalWallet] - # # @param email [String, nil] - # # @param one_time_passcode [String] - # # @param phone [String, nil] - # # @param result [Symbol, Increase::Models::RealTimeDecision::DigitalWalletAuthentication::Result, nil] - # # - # def initialize(card_id:, channel:, digital_wallet:, email:, one_time_passcode:, phone:, result:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(card_id:, channel:, digital_wallet:, email:, one_time_passcode:, phone:, result:) + # Fields related to a digital wallet authentication attempt. + # + # @param card_id [String] + # @param channel [Symbol, Increase::Models::RealTimeDecision::DigitalWalletAuthentication::Channel] + # @param digital_wallet [Symbol, Increase::Models::RealTimeDecision::DigitalWalletAuthentication::DigitalWallet] + # @param email [String, nil] + # @param one_time_passcode [String] + # @param phone [String, nil] + # @param result [Symbol, Increase::Models::RealTimeDecision::DigitalWalletAuthentication::Result, nil] # The channel to send the card user their one-time passcode. # @@ -1130,11 +995,8 @@ module Channel # Send one-time passcodes over email. EMAIL = :email - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # The digital wallet app being used. @@ -1155,11 +1017,8 @@ module DigitalWallet # Unknown UNKNOWN = :unknown - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # Whether your application successfully delivered the one-time passcode. @@ -1174,11 +1033,8 @@ module Result # Your application failed to deliver the one-time passcode to the cardholder. FAILURE = :failure - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -1220,18 +1076,14 @@ class DigitalWalletToken < Increase::Internal::Type::BaseModel required :digital_wallet, enum: -> { Increase::Models::RealTimeDecision::DigitalWalletToken::DigitalWallet } - # @!parse - # # Fields related to a digital wallet token provisioning attempt. - # # - # # @param card_id [String] - # # @param card_profile_id [String, nil] - # # @param decision [Symbol, Increase::Models::RealTimeDecision::DigitalWalletToken::Decision, nil] - # # @param device [Increase::Models::RealTimeDecision::DigitalWalletToken::Device] - # # @param digital_wallet [Symbol, Increase::Models::RealTimeDecision::DigitalWalletToken::DigitalWallet] - # # - # def initialize(card_id:, card_profile_id:, decision:, device:, digital_wallet:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(card_id:, card_profile_id:, decision:, device:, digital_wallet:) + # Fields related to a digital wallet token provisioning attempt. + # + # @param card_id [String] + # @param card_profile_id [String, nil] + # @param decision [Symbol, Increase::Models::RealTimeDecision::DigitalWalletToken::Decision, nil] + # @param device [Increase::Models::RealTimeDecision::DigitalWalletToken::Device] + # @param digital_wallet [Symbol, Increase::Models::RealTimeDecision::DigitalWalletToken::DigitalWallet] # Whether or not the provisioning request was approved. This will be null until # the real time decision is responded to. @@ -1246,11 +1098,8 @@ module Decision # Decline the provisioning request. DECLINE = :decline - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Increase::Models::RealTimeDecision::DigitalWalletToken#device @@ -1261,14 +1110,10 @@ class Device < Increase::Internal::Type::BaseModel # @return [String, nil] required :identifier, String, nil?: true - # @!parse - # # Device that is being used to provision the digital wallet token. - # # - # # @param identifier [String, nil] - # # - # def initialize(identifier:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(identifier:) + # Device that is being used to provision the digital wallet token. + # + # @param identifier [String, nil] end # The digital wallet app being used. @@ -1289,11 +1134,8 @@ module DigitalWallet # Unknown UNKNOWN = :unknown - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -1312,11 +1154,8 @@ module Status # Your webhook failed to respond to the authorization in time. TIMED_OUT = :timed_out - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # A constant representing the object's type. For this resource it will always be @@ -1328,11 +1167,8 @@ module Type REAL_TIME_DECISION = :real_time_decision - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end diff --git a/lib/increase/models/real_time_decision_action_params.rb b/lib/increase/models/real_time_decision_action_params.rb index af5253a2d..4880a75e6 100644 --- a/lib/increase/models/real_time_decision_action_params.rb +++ b/lib/increase/models/real_time_decision_action_params.rb @@ -4,22 +4,17 @@ module Increase module Models # @see Increase::Resources::RealTimeDecisions#action class RealTimeDecisionActionParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters - # @!attribute [r] card_authentication + # @!attribute card_authentication # If the Real-Time Decision relates to a 3DS card authentication attempt, this # object contains your response to the authentication. # # @return [Increase::Models::RealTimeDecisionActionParams::CardAuthentication, nil] optional :card_authentication, -> { Increase::Models::RealTimeDecisionActionParams::CardAuthentication } - # @!parse - # # @return [Increase::Models::RealTimeDecisionActionParams::CardAuthentication] - # attr_writer :card_authentication - - # @!attribute [r] card_authentication_challenge + # @!attribute card_authentication_challenge # If the Real-Time Decision relates to 3DS card authentication challenge delivery, # this object contains your response. # @@ -27,22 +22,14 @@ class RealTimeDecisionActionParams < Increase::Internal::Type::BaseModel optional :card_authentication_challenge, -> { Increase::Models::RealTimeDecisionActionParams::CardAuthenticationChallenge } - # @!parse - # # @return [Increase::Models::RealTimeDecisionActionParams::CardAuthenticationChallenge] - # attr_writer :card_authentication_challenge - - # @!attribute [r] card_authorization + # @!attribute card_authorization # If the Real-Time Decision relates to a card authorization attempt, this object # contains your response to the authorization. # # @return [Increase::Models::RealTimeDecisionActionParams::CardAuthorization, nil] optional :card_authorization, -> { Increase::Models::RealTimeDecisionActionParams::CardAuthorization } - # @!parse - # # @return [Increase::Models::RealTimeDecisionActionParams::CardAuthorization] - # attr_writer :card_authorization - - # @!attribute [r] digital_wallet_authentication + # @!attribute digital_wallet_authentication # If the Real-Time Decision relates to a digital wallet authentication attempt, # this object contains your response to the authentication. # @@ -50,42 +37,20 @@ class RealTimeDecisionActionParams < Increase::Internal::Type::BaseModel optional :digital_wallet_authentication, -> { Increase::Models::RealTimeDecisionActionParams::DigitalWalletAuthentication } - # @!parse - # # @return [Increase::Models::RealTimeDecisionActionParams::DigitalWalletAuthentication] - # attr_writer :digital_wallet_authentication - - # @!attribute [r] digital_wallet_token + # @!attribute digital_wallet_token # If the Real-Time Decision relates to a digital wallet token provisioning # attempt, this object contains your response to the attempt. # # @return [Increase::Models::RealTimeDecisionActionParams::DigitalWalletToken, nil] optional :digital_wallet_token, -> { Increase::Models::RealTimeDecisionActionParams::DigitalWalletToken } - # @!parse - # # @return [Increase::Models::RealTimeDecisionActionParams::DigitalWalletToken] - # attr_writer :digital_wallet_token - - # @!parse - # # @param card_authentication [Increase::Models::RealTimeDecisionActionParams::CardAuthentication] - # # @param card_authentication_challenge [Increase::Models::RealTimeDecisionActionParams::CardAuthenticationChallenge] - # # @param card_authorization [Increase::Models::RealTimeDecisionActionParams::CardAuthorization] - # # @param digital_wallet_authentication [Increase::Models::RealTimeDecisionActionParams::DigitalWalletAuthentication] - # # @param digital_wallet_token [Increase::Models::RealTimeDecisionActionParams::DigitalWalletToken] - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize( - # card_authentication: nil, - # card_authentication_challenge: nil, - # card_authorization: nil, - # digital_wallet_authentication: nil, - # digital_wallet_token: nil, - # request_options: {}, - # ** - # ) - # super - # end - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(card_authentication: nil, card_authentication_challenge: nil, card_authorization: nil, digital_wallet_authentication: nil, digital_wallet_token: nil, request_options: {}) + # @param card_authentication [Increase::Models::RealTimeDecisionActionParams::CardAuthentication] + # @param card_authentication_challenge [Increase::Models::RealTimeDecisionActionParams::CardAuthenticationChallenge] + # @param card_authorization [Increase::Models::RealTimeDecisionActionParams::CardAuthorization] + # @param digital_wallet_authentication [Increase::Models::RealTimeDecisionActionParams::DigitalWalletAuthentication] + # @param digital_wallet_token [Increase::Models::RealTimeDecisionActionParams::DigitalWalletToken] + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] class CardAuthentication < Increase::Internal::Type::BaseModel # @!attribute decision @@ -95,15 +60,11 @@ class CardAuthentication < Increase::Internal::Type::BaseModel required :decision, enum: -> { Increase::Models::RealTimeDecisionActionParams::CardAuthentication::Decision } - # @!parse - # # If the Real-Time Decision relates to a 3DS card authentication attempt, this - # # object contains your response to the authentication. - # # - # # @param decision [Symbol, Increase::Models::RealTimeDecisionActionParams::CardAuthentication::Decision] - # # - # def initialize(decision:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(decision:) + # If the Real-Time Decision relates to a 3DS card authentication attempt, this + # object contains your response to the authentication. + # + # @param decision [Symbol, Increase::Models::RealTimeDecisionActionParams::CardAuthentication::Decision] # Whether the card authentication attempt should be approved or declined. # @@ -120,11 +81,8 @@ module Decision # Deny the authentication attempt. DENY = :deny - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -137,15 +95,11 @@ class CardAuthenticationChallenge < Increase::Internal::Type::BaseModel required :result, enum: -> { Increase::Models::RealTimeDecisionActionParams::CardAuthenticationChallenge::Result } - # @!parse - # # If the Real-Time Decision relates to 3DS card authentication challenge delivery, - # # this object contains your response. - # # - # # @param result [Symbol, Increase::Models::RealTimeDecisionActionParams::CardAuthenticationChallenge::Result] - # # - # def initialize(result:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(result:) + # If the Real-Time Decision relates to 3DS card authentication challenge delivery, + # this object contains your response. + # + # @param result [Symbol, Increase::Models::RealTimeDecisionActionParams::CardAuthenticationChallenge::Result] # Whether the card authentication challenge was successfully delivered to the # cardholder. @@ -160,11 +114,8 @@ module Result # Your application was unable to deliver the one-time code to the cardholder. FAILURE = :failure - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -176,7 +127,7 @@ class CardAuthorization < Increase::Internal::Type::BaseModel required :decision, enum: -> { Increase::Models::RealTimeDecisionActionParams::CardAuthorization::Decision } - # @!attribute [r] decline_reason + # @!attribute decline_reason # The reason the card authorization was declined. This translates to a specific # decline code that is sent to the card network. # @@ -184,20 +135,12 @@ class CardAuthorization < Increase::Internal::Type::BaseModel optional :decline_reason, enum: -> { Increase::Models::RealTimeDecisionActionParams::CardAuthorization::DeclineReason } - # @!parse - # # @return [Symbol, Increase::Models::RealTimeDecisionActionParams::CardAuthorization::DeclineReason] - # attr_writer :decline_reason - - # @!parse - # # If the Real-Time Decision relates to a card authorization attempt, this object - # # contains your response to the authorization. - # # - # # @param decision [Symbol, Increase::Models::RealTimeDecisionActionParams::CardAuthorization::Decision] - # # @param decline_reason [Symbol, Increase::Models::RealTimeDecisionActionParams::CardAuthorization::DeclineReason] - # # - # def initialize(decision:, decline_reason: nil, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(decision:, decline_reason: nil) + # If the Real-Time Decision relates to a card authorization attempt, this object + # contains your response to the authorization. + # + # @param decision [Symbol, Increase::Models::RealTimeDecisionActionParams::CardAuthorization::Decision] + # @param decline_reason [Symbol, Increase::Models::RealTimeDecisionActionParams::CardAuthorization::DeclineReason] # Whether the card authorization should be approved or declined. # @@ -211,11 +154,8 @@ module Decision # Decline the authorization. DECLINE = :decline - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # The reason the card authorization was declined. This translates to a specific @@ -243,11 +183,8 @@ module DeclineReason # The transaction was declined for another reason. The merchant may attempt to process the transaction again. This should be used sparingly. OTHER = :other - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -259,26 +196,18 @@ class DigitalWalletAuthentication < Increase::Internal::Type::BaseModel required :result, enum: -> { Increase::Models::RealTimeDecisionActionParams::DigitalWalletAuthentication::Result } - # @!attribute [r] success + # @!attribute success # # @return [Increase::Models::RealTimeDecisionActionParams::DigitalWalletAuthentication::Success, nil] optional :success, -> { Increase::Models::RealTimeDecisionActionParams::DigitalWalletAuthentication::Success } - # @!parse - # # @return [Increase::Models::RealTimeDecisionActionParams::DigitalWalletAuthentication::Success] - # attr_writer :success - - # @!parse - # # If the Real-Time Decision relates to a digital wallet authentication attempt, - # # this object contains your response to the authentication. - # # - # # @param result [Symbol, Increase::Models::RealTimeDecisionActionParams::DigitalWalletAuthentication::Result] - # # @param success [Increase::Models::RealTimeDecisionActionParams::DigitalWalletAuthentication::Success] - # # - # def initialize(result:, success: nil, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(result:, success: nil) + # If the Real-Time Decision relates to a digital wallet authentication attempt, + # this object contains your response to the authentication. + # + # @param result [Symbol, Increase::Models::RealTimeDecisionActionParams::DigitalWalletAuthentication::Result] + # @param success [Increase::Models::RealTimeDecisionActionParams::DigitalWalletAuthentication::Success] # Whether your application was able to deliver the one-time passcode. # @@ -292,138 +221,91 @@ module Result # Your application failed to deliver the one-time passcode to the cardholder. FAILURE = :failure - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Increase::Models::RealTimeDecisionActionParams::DigitalWalletAuthentication#success class Success < Increase::Internal::Type::BaseModel - # @!attribute [r] email + # @!attribute email # The email address that was used to verify the cardholder via one-time passcode. # # @return [String, nil] optional :email, String - # @!parse - # # @return [String] - # attr_writer :email - - # @!attribute [r] phone + # @!attribute phone # The phone number that was used to verify the cardholder via one-time passcode # over SMS. # # @return [String, nil] optional :phone, String - # @!parse - # # @return [String] - # attr_writer :phone - - # @!parse - # # @param email [String] - # # @param phone [String] - # # - # def initialize(email: nil, phone: nil, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(email: nil, phone: nil) + # @param email [String] + # @param phone [String] end end class DigitalWalletToken < Increase::Internal::Type::BaseModel - # @!attribute [r] approval + # @!attribute approval # If your application approves the provisioning attempt, this contains metadata # about the digital wallet token that will be generated. # # @return [Increase::Models::RealTimeDecisionActionParams::DigitalWalletToken::Approval, nil] optional :approval, -> { Increase::Models::RealTimeDecisionActionParams::DigitalWalletToken::Approval } - # @!parse - # # @return [Increase::Models::RealTimeDecisionActionParams::DigitalWalletToken::Approval] - # attr_writer :approval - - # @!attribute [r] decline + # @!attribute decline # If your application declines the provisioning attempt, this contains details # about the decline. # # @return [Increase::Models::RealTimeDecisionActionParams::DigitalWalletToken::Decline, nil] optional :decline, -> { Increase::Models::RealTimeDecisionActionParams::DigitalWalletToken::Decline } - # @!parse - # # @return [Increase::Models::RealTimeDecisionActionParams::DigitalWalletToken::Decline] - # attr_writer :decline - - # @!parse - # # If the Real-Time Decision relates to a digital wallet token provisioning - # # attempt, this object contains your response to the attempt. - # # - # # @param approval [Increase::Models::RealTimeDecisionActionParams::DigitalWalletToken::Approval] - # # @param decline [Increase::Models::RealTimeDecisionActionParams::DigitalWalletToken::Decline] - # # - # def initialize(approval: nil, decline: nil, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(approval: nil, decline: nil) + # If the Real-Time Decision relates to a digital wallet token provisioning + # attempt, this object contains your response to the attempt. + # + # @param approval [Increase::Models::RealTimeDecisionActionParams::DigitalWalletToken::Approval] + # @param decline [Increase::Models::RealTimeDecisionActionParams::DigitalWalletToken::Decline] # @see Increase::Models::RealTimeDecisionActionParams::DigitalWalletToken#approval class Approval < Increase::Internal::Type::BaseModel - # @!attribute [r] email + # @!attribute email # An email address that can be used to verify the cardholder via one-time # passcode. # # @return [String, nil] optional :email, String - # @!parse - # # @return [String] - # attr_writer :email - - # @!attribute [r] phone + # @!attribute phone # A phone number that can be used to verify the cardholder via one-time passcode # over SMS. # # @return [String, nil] optional :phone, String - # @!parse - # # @return [String] - # attr_writer :phone - - # @!parse - # # If your application approves the provisioning attempt, this contains metadata - # # about the digital wallet token that will be generated. - # # - # # @param email [String] - # # @param phone [String] - # # - # def initialize(email: nil, phone: nil, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(email: nil, phone: nil) + # If your application approves the provisioning attempt, this contains metadata + # about the digital wallet token that will be generated. + # + # @param email [String] + # @param phone [String] end # @see Increase::Models::RealTimeDecisionActionParams::DigitalWalletToken#decline class Decline < Increase::Internal::Type::BaseModel - # @!attribute [r] reason + # @!attribute reason # Why the tokenization attempt was declined. This is for logging purposes only and # is not displayed to the end-user. # # @return [String, nil] optional :reason, String - # @!parse - # # @return [String] - # attr_writer :reason - - # @!parse - # # If your application declines the provisioning attempt, this contains details - # # about the decline. - # # - # # @param reason [String] - # # - # def initialize(reason: nil, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(reason: nil) + # If your application declines the provisioning attempt, this contains details + # about the decline. + # + # @param reason [String] end end end diff --git a/lib/increase/models/real_time_decision_retrieve_params.rb b/lib/increase/models/real_time_decision_retrieve_params.rb index bdb324d58..65f5a2a5c 100644 --- a/lib/increase/models/real_time_decision_retrieve_params.rb +++ b/lib/increase/models/real_time_decision_retrieve_params.rb @@ -4,16 +4,11 @@ module Increase module Models # @see Increase::Resources::RealTimeDecisions#retrieve class RealTimeDecisionRetrieveParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters - # @!parse - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(request_options: {}, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(request_options: {}) + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/increase/models/real_time_payments_transfer.rb b/lib/increase/models/real_time_payments_transfer.rb index 0354753f7..8b05c59a8 100644 --- a/lib/increase/models/real_time_payments_transfer.rb +++ b/lib/increase/models/real_time_payments_transfer.rb @@ -172,68 +172,35 @@ class RealTimePaymentsTransfer < Increase::Internal::Type::BaseModel # @return [String, nil] required :ultimate_debtor_name, String, nil?: true - # @!parse - # # Real-Time Payments transfers move funds, within seconds, between your Increase - # # account and any other account on the Real-Time Payments network. - # # - # # @param id [String] - # # @param account_id [String] - # # @param acknowledgement [Increase::Models::RealTimePaymentsTransfer::Acknowledgement, nil] - # # @param amount [Integer] - # # @param approval [Increase::Models::RealTimePaymentsTransfer::Approval, nil] - # # @param cancellation [Increase::Models::RealTimePaymentsTransfer::Cancellation, nil] - # # @param created_at [Time] - # # @param created_by [Increase::Models::RealTimePaymentsTransfer::CreatedBy, nil] - # # @param creditor_name [String] - # # @param currency [Symbol, Increase::Models::RealTimePaymentsTransfer::Currency] - # # @param debtor_name [String, nil] - # # @param destination_account_number [String] - # # @param destination_routing_number [String] - # # @param external_account_id [String, nil] - # # @param idempotency_key [String, nil] - # # @param pending_transaction_id [String, nil] - # # @param rejection [Increase::Models::RealTimePaymentsTransfer::Rejection, nil] - # # @param remittance_information [String] - # # @param source_account_number_id [String] - # # @param status [Symbol, Increase::Models::RealTimePaymentsTransfer::Status] - # # @param submission [Increase::Models::RealTimePaymentsTransfer::Submission, nil] - # # @param transaction_id [String, nil] - # # @param type [Symbol, Increase::Models::RealTimePaymentsTransfer::Type] - # # @param ultimate_creditor_name [String, nil] - # # @param ultimate_debtor_name [String, nil] - # # - # def initialize( - # id:, - # account_id:, - # acknowledgement:, - # amount:, - # approval:, - # cancellation:, - # created_at:, - # created_by:, - # creditor_name:, - # currency:, - # debtor_name:, - # destination_account_number:, - # destination_routing_number:, - # external_account_id:, - # idempotency_key:, - # pending_transaction_id:, - # rejection:, - # remittance_information:, - # source_account_number_id:, - # status:, - # submission:, - # transaction_id:, - # type:, - # ultimate_creditor_name:, - # ultimate_debtor_name:, - # ** - # ) - # super - # end - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(id:, account_id:, acknowledgement:, amount:, approval:, cancellation:, created_at:, created_by:, creditor_name:, currency:, debtor_name:, destination_account_number:, destination_routing_number:, external_account_id:, idempotency_key:, pending_transaction_id:, rejection:, remittance_information:, source_account_number_id:, status:, submission:, transaction_id:, type:, ultimate_creditor_name:, ultimate_debtor_name:) + # Real-Time Payments transfers move funds, within seconds, between your Increase + # account and any other account on the Real-Time Payments network. + # + # @param id [String] + # @param account_id [String] + # @param acknowledgement [Increase::Models::RealTimePaymentsTransfer::Acknowledgement, nil] + # @param amount [Integer] + # @param approval [Increase::Models::RealTimePaymentsTransfer::Approval, nil] + # @param cancellation [Increase::Models::RealTimePaymentsTransfer::Cancellation, nil] + # @param created_at [Time] + # @param created_by [Increase::Models::RealTimePaymentsTransfer::CreatedBy, nil] + # @param creditor_name [String] + # @param currency [Symbol, Increase::Models::RealTimePaymentsTransfer::Currency] + # @param debtor_name [String, nil] + # @param destination_account_number [String] + # @param destination_routing_number [String] + # @param external_account_id [String, nil] + # @param idempotency_key [String, nil] + # @param pending_transaction_id [String, nil] + # @param rejection [Increase::Models::RealTimePaymentsTransfer::Rejection, nil] + # @param remittance_information [String] + # @param source_account_number_id [String] + # @param status [Symbol, Increase::Models::RealTimePaymentsTransfer::Status] + # @param submission [Increase::Models::RealTimePaymentsTransfer::Submission, nil] + # @param transaction_id [String, nil] + # @param type [Symbol, Increase::Models::RealTimePaymentsTransfer::Type] + # @param ultimate_creditor_name [String, nil] + # @param ultimate_debtor_name [String, nil] # @see Increase::Models::RealTimePaymentsTransfer#acknowledgement class Acknowledgement < Increase::Internal::Type::BaseModel @@ -243,15 +210,11 @@ class Acknowledgement < Increase::Internal::Type::BaseModel # @return [Time] required :acknowledged_at, Time - # @!parse - # # If the transfer is acknowledged by the recipient bank, this will contain - # # supplemental details. - # # - # # @param acknowledged_at [Time] - # # - # def initialize(acknowledged_at:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(acknowledged_at:) + # If the transfer is acknowledged by the recipient bank, this will contain + # supplemental details. + # + # @param acknowledged_at [Time] end # @see Increase::Models::RealTimePaymentsTransfer#approval @@ -270,16 +233,12 @@ class Approval < Increase::Internal::Type::BaseModel # @return [String, nil] required :approved_by, String, nil?: true - # @!parse - # # If your account requires approvals for transfers and the transfer was approved, - # # this will contain details of the approval. - # # - # # @param approved_at [Time] - # # @param approved_by [String, nil] - # # - # def initialize(approved_at:, approved_by:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(approved_at:, approved_by:) + # If your account requires approvals for transfers and the transfer was approved, + # this will contain details of the approval. + # + # @param approved_at [Time] + # @param approved_by [String, nil] end # @see Increase::Models::RealTimePaymentsTransfer#cancellation @@ -298,16 +257,12 @@ class Cancellation < Increase::Internal::Type::BaseModel # @return [String, nil] required :canceled_by, String, nil?: true - # @!parse - # # If your account requires approvals for transfers and the transfer was not - # # approved, this will contain details of the cancellation. - # # - # # @param canceled_at [Time] - # # @param canceled_by [String, nil] - # # - # def initialize(canceled_at:, canceled_by:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(canceled_at:, canceled_by:) + # If your account requires approvals for transfers and the transfer was not + # approved, this will contain details of the cancellation. + # + # @param canceled_at [Time] + # @param canceled_by [String, nil] end # @see Increase::Models::RealTimePaymentsTransfer#created_by @@ -338,17 +293,13 @@ class CreatedBy < Increase::Internal::Type::BaseModel # @return [Increase::Models::RealTimePaymentsTransfer::CreatedBy::User, nil] required :user, -> { Increase::Models::RealTimePaymentsTransfer::CreatedBy::User }, nil?: true - # @!parse - # # What object created the transfer, either via the API or the dashboard. - # # - # # @param api_key [Increase::Models::RealTimePaymentsTransfer::CreatedBy::APIKey, nil] - # # @param category [Symbol, Increase::Models::RealTimePaymentsTransfer::CreatedBy::Category] - # # @param oauth_application [Increase::Models::RealTimePaymentsTransfer::CreatedBy::OAuthApplication, nil] - # # @param user [Increase::Models::RealTimePaymentsTransfer::CreatedBy::User, nil] - # # - # def initialize(api_key:, category:, oauth_application:, user:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(api_key:, category:, oauth_application:, user:) + # What object created the transfer, either via the API or the dashboard. + # + # @param api_key [Increase::Models::RealTimePaymentsTransfer::CreatedBy::APIKey, nil] + # @param category [Symbol, Increase::Models::RealTimePaymentsTransfer::CreatedBy::Category] + # @param oauth_application [Increase::Models::RealTimePaymentsTransfer::CreatedBy::OAuthApplication, nil] + # @param user [Increase::Models::RealTimePaymentsTransfer::CreatedBy::User, nil] # @see Increase::Models::RealTimePaymentsTransfer::CreatedBy#api_key class APIKey < Increase::Internal::Type::BaseModel @@ -358,14 +309,10 @@ class APIKey < Increase::Internal::Type::BaseModel # @return [String, nil] required :description, String, nil?: true - # @!parse - # # If present, details about the API key that created the transfer. - # # - # # @param description [String, nil] - # # - # def initialize(description:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(description:) + # If present, details about the API key that created the transfer. + # + # @param description [String, nil] end # The type of object that created this transfer. @@ -383,11 +330,8 @@ module Category # A User in the Increase dashboard. Details will be under the `user` object. USER = :user - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Increase::Models::RealTimePaymentsTransfer::CreatedBy#oauth_application @@ -398,14 +342,10 @@ class OAuthApplication < Increase::Internal::Type::BaseModel # @return [String] required :name, String - # @!parse - # # If present, details about the OAuth Application that created the transfer. - # # - # # @param name [String] - # # - # def initialize(name:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(name:) + # If present, details about the OAuth Application that created the transfer. + # + # @param name [String] end # @see Increase::Models::RealTimePaymentsTransfer::CreatedBy#user @@ -416,14 +356,10 @@ class User < Increase::Internal::Type::BaseModel # @return [String] required :email, String - # @!parse - # # If present, details about the User that created the transfer. - # # - # # @param email [String] - # # - # def initialize(email:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(email:) + # If present, details about the User that created the transfer. + # + # @param email [String] end end @@ -452,11 +388,8 @@ module Currency # US Dollar (USD) USD = :USD - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Increase::Models::RealTimePaymentsTransfer#rejection @@ -483,17 +416,13 @@ class Rejection < Increase::Internal::Type::BaseModel # @return [Time, nil] required :rejected_at, Time, nil?: true - # @!parse - # # If the transfer is rejected by Real-Time Payments or the destination financial - # # institution, this will contain supplemental details. - # # - # # @param reject_reason_additional_information [String, nil] - # # @param reject_reason_code [Symbol, Increase::Models::RealTimePaymentsTransfer::Rejection::RejectReasonCode] - # # @param rejected_at [Time, nil] - # # - # def initialize(reject_reason_additional_information:, reject_reason_code:, rejected_at:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(reject_reason_additional_information:, reject_reason_code:, rejected_at:) + # If the transfer is rejected by Real-Time Payments or the destination financial + # institution, this will contain supplemental details. + # + # @param reject_reason_additional_information [String, nil] + # @param reject_reason_code [Symbol, Increase::Models::RealTimePaymentsTransfer::Rejection::RejectReasonCode] + # @param rejected_at [Time, nil] # The reason the transfer was rejected as provided by the recipient bank or the # Real-Time Payments network. @@ -565,11 +494,8 @@ module RejectReasonCode # Some other error or issue has occurred. OTHER = :other - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -603,11 +529,8 @@ module Status # The transfer has been sent successfully and is complete. COMPLETE = :complete - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Increase::Models::RealTimePaymentsTransfer#submission @@ -625,16 +548,12 @@ class Submission < Increase::Internal::Type::BaseModel # @return [String] required :transaction_identification, String - # @!parse - # # After the transfer is submitted to Real-Time Payments, this will contain - # # supplemental details. - # # - # # @param submitted_at [Time, nil] - # # @param transaction_identification [String] - # # - # def initialize(submitted_at:, transaction_identification:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(submitted_at:, transaction_identification:) + # After the transfer is submitted to Real-Time Payments, this will contain + # supplemental details. + # + # @param submitted_at [Time, nil] + # @param transaction_identification [String] end # A constant representing the object's type. For this resource it will always be @@ -646,11 +565,8 @@ module Type REAL_TIME_PAYMENTS_TRANSFER = :real_time_payments_transfer - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end diff --git a/lib/increase/models/real_time_payments_transfer_create_params.rb b/lib/increase/models/real_time_payments_transfer_create_params.rb index 69b82d563..ec2d91a4a 100644 --- a/lib/increase/models/real_time_payments_transfer_create_params.rb +++ b/lib/increase/models/real_time_payments_transfer_create_params.rb @@ -4,8 +4,7 @@ module Increase module Models # @see Increase::Resources::RealTimePaymentsTransfers#create class RealTimePaymentsTransferCreateParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters # @!attribute amount @@ -33,39 +32,27 @@ class RealTimePaymentsTransferCreateParams < Increase::Internal::Type::BaseModel # @return [String] required :source_account_number_id, String - # @!attribute [r] debtor_name + # @!attribute debtor_name # The name of the transfer's sender. If not provided, defaults to the name of the # account's entity. # # @return [String, nil] optional :debtor_name, String - # @!parse - # # @return [String] - # attr_writer :debtor_name - - # @!attribute [r] destination_account_number + # @!attribute destination_account_number # The destination account number. # # @return [String, nil] optional :destination_account_number, String - # @!parse - # # @return [String] - # attr_writer :destination_account_number - - # @!attribute [r] destination_routing_number + # @!attribute destination_routing_number # The destination American Bankers' Association (ABA) Routing Transit Number # (RTN). # # @return [String, nil] optional :destination_routing_number, String - # @!parse - # # @return [String] - # attr_writer :destination_routing_number - - # @!attribute [r] external_account_id + # @!attribute external_account_id # The ID of an External Account to initiate a transfer to. If this parameter is # provided, `destination_account_number` and `destination_routing_number` must be # absent. @@ -73,75 +60,39 @@ class RealTimePaymentsTransferCreateParams < Increase::Internal::Type::BaseModel # @return [String, nil] optional :external_account_id, String - # @!parse - # # @return [String] - # attr_writer :external_account_id - - # @!attribute [r] require_approval + # @!attribute require_approval # Whether the transfer requires explicit approval via the dashboard or API. # # @return [Boolean, nil] optional :require_approval, Increase::Internal::Type::Boolean - # @!parse - # # @return [Boolean] - # attr_writer :require_approval - - # @!attribute [r] ultimate_creditor_name + # @!attribute ultimate_creditor_name # The name of the ultimate recipient of the transfer. Set this if the creditor is # an intermediary receiving the payment for someone else. # # @return [String, nil] optional :ultimate_creditor_name, String - # @!parse - # # @return [String] - # attr_writer :ultimate_creditor_name - - # @!attribute [r] ultimate_debtor_name + # @!attribute ultimate_debtor_name # The name of the ultimate sender of the transfer. Set this if the funds are being # sent on behalf of someone who is not the account holder at Increase. # # @return [String, nil] optional :ultimate_debtor_name, String - # @!parse - # # @return [String] - # attr_writer :ultimate_debtor_name - - # @!parse - # # @param amount [Integer] - # # @param creditor_name [String] - # # @param remittance_information [String] - # # @param source_account_number_id [String] - # # @param debtor_name [String] - # # @param destination_account_number [String] - # # @param destination_routing_number [String] - # # @param external_account_id [String] - # # @param require_approval [Boolean] - # # @param ultimate_creditor_name [String] - # # @param ultimate_debtor_name [String] - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize( - # amount:, - # creditor_name:, - # remittance_information:, - # source_account_number_id:, - # debtor_name: nil, - # destination_account_number: nil, - # destination_routing_number: nil, - # external_account_id: nil, - # require_approval: nil, - # ultimate_creditor_name: nil, - # ultimate_debtor_name: nil, - # request_options: {}, - # ** - # ) - # super - # end - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(amount:, creditor_name:, remittance_information:, source_account_number_id:, debtor_name: nil, destination_account_number: nil, destination_routing_number: nil, external_account_id: nil, require_approval: nil, ultimate_creditor_name: nil, ultimate_debtor_name: nil, request_options: {}) + # @param amount [Integer] + # @param creditor_name [String] + # @param remittance_information [String] + # @param source_account_number_id [String] + # @param debtor_name [String] + # @param destination_account_number [String] + # @param destination_routing_number [String] + # @param external_account_id [String] + # @param require_approval [Boolean] + # @param ultimate_creditor_name [String] + # @param ultimate_debtor_name [String] + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/increase/models/real_time_payments_transfer_list_params.rb b/lib/increase/models/real_time_payments_transfer_list_params.rb index aa1b5fdb6..e960de76e 100644 --- a/lib/increase/models/real_time_payments_transfer_list_params.rb +++ b/lib/increase/models/real_time_payments_transfer_list_params.rb @@ -4,51 +4,34 @@ module Increase module Models # @see Increase::Resources::RealTimePaymentsTransfers#list class RealTimePaymentsTransferListParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters - # @!attribute [r] account_id + # @!attribute account_id # Filter Real-Time Payments Transfers to those belonging to the specified Account. # # @return [String, nil] optional :account_id, String - # @!parse - # # @return [String] - # attr_writer :account_id - - # @!attribute [r] created_at + # @!attribute created_at # # @return [Increase::Models::RealTimePaymentsTransferListParams::CreatedAt, nil] optional :created_at, -> { Increase::Models::RealTimePaymentsTransferListParams::CreatedAt } - # @!parse - # # @return [Increase::Models::RealTimePaymentsTransferListParams::CreatedAt] - # attr_writer :created_at - - # @!attribute [r] cursor + # @!attribute cursor # Return the page of entries after this one. # # @return [String, nil] optional :cursor, String - # @!parse - # # @return [String] - # attr_writer :cursor - - # @!attribute [r] external_account_id + # @!attribute external_account_id # Filter Real-Time Payments Transfers to those made to the specified External # Account. # # @return [String, nil] optional :external_account_id, String - # @!parse - # # @return [String] - # attr_writer :external_account_id - - # @!attribute [r] idempotency_key + # @!attribute idempotency_key # Filter records to the one with the specified `idempotency_key` you chose for # that object. This value is unique across Increase and is used to ensure that a # request is only processed once. Learn more about @@ -57,114 +40,66 @@ class RealTimePaymentsTransferListParams < Increase::Internal::Type::BaseModel # @return [String, nil] optional :idempotency_key, String - # @!parse - # # @return [String] - # attr_writer :idempotency_key - - # @!attribute [r] limit + # @!attribute limit # Limit the size of the list that is returned. The default (and maximum) is 100 # objects. # # @return [Integer, nil] optional :limit, Integer - # @!parse - # # @return [Integer] - # attr_writer :limit - - # @!attribute [r] status + # @!attribute status # # @return [Increase::Models::RealTimePaymentsTransferListParams::Status, nil] optional :status, -> { Increase::Models::RealTimePaymentsTransferListParams::Status } - # @!parse - # # @return [Increase::Models::RealTimePaymentsTransferListParams::Status] - # attr_writer :status - - # @!parse - # # @param account_id [String] - # # @param created_at [Increase::Models::RealTimePaymentsTransferListParams::CreatedAt] - # # @param cursor [String] - # # @param external_account_id [String] - # # @param idempotency_key [String] - # # @param limit [Integer] - # # @param status [Increase::Models::RealTimePaymentsTransferListParams::Status] - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize( - # account_id: nil, - # created_at: nil, - # cursor: nil, - # external_account_id: nil, - # idempotency_key: nil, - # limit: nil, - # status: nil, - # request_options: {}, - # ** - # ) - # super - # end - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(account_id: nil, created_at: nil, cursor: nil, external_account_id: nil, idempotency_key: nil, limit: nil, status: nil, request_options: {}) + # @param account_id [String] + # @param created_at [Increase::Models::RealTimePaymentsTransferListParams::CreatedAt] + # @param cursor [String] + # @param external_account_id [String] + # @param idempotency_key [String] + # @param limit [Integer] + # @param status [Increase::Models::RealTimePaymentsTransferListParams::Status] + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] class CreatedAt < Increase::Internal::Type::BaseModel - # @!attribute [r] after + # @!attribute after # Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) # timestamp. # # @return [Time, nil] optional :after, Time - # @!parse - # # @return [Time] - # attr_writer :after - - # @!attribute [r] before + # @!attribute before # Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) # timestamp. # # @return [Time, nil] optional :before, Time - # @!parse - # # @return [Time] - # attr_writer :before - - # @!attribute [r] on_or_after + # @!attribute on_or_after # Return results on or after this # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. # # @return [Time, nil] optional :on_or_after, Time - # @!parse - # # @return [Time] - # attr_writer :on_or_after - - # @!attribute [r] on_or_before + # @!attribute on_or_before # Return results on or before this # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. # # @return [Time, nil] optional :on_or_before, Time - # @!parse - # # @return [Time] - # attr_writer :on_or_before - - # @!parse - # # @param after [Time] - # # @param before [Time] - # # @param on_or_after [Time] - # # @param on_or_before [Time] - # # - # def initialize(after: nil, before: nil, on_or_after: nil, on_or_before: nil, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(after: nil, before: nil, on_or_after: nil, on_or_before: nil) + # @param after [Time] + # @param before [Time] + # @param on_or_after [Time] + # @param on_or_before [Time] end class Status < Increase::Internal::Type::BaseModel - # @!attribute [r] in_ + # @!attribute in_ # Return results whose value is in the provided list. For GET requests, this # should be encoded as a comma-delimited string, such as `?in=one,two,three`. # @@ -173,16 +108,8 @@ class Status < Increase::Internal::Type::BaseModel -> { Increase::Internal::Type::ArrayOf[enum: Increase::Models::RealTimePaymentsTransferListParams::Status::In] }, api_name: :in - # @!parse - # # @return [Array] - # attr_writer :in_ - - # @!parse - # # @param in_ [Array] - # # - # def initialize(in_: nil, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(in_: nil) + # @param in_ [Array] module In extend Increase::Internal::Type::Enum @@ -211,11 +138,8 @@ module In # The transfer has been sent successfully and is complete. COMPLETE = :complete - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end diff --git a/lib/increase/models/real_time_payments_transfer_retrieve_params.rb b/lib/increase/models/real_time_payments_transfer_retrieve_params.rb index 8dc38adab..012bceaea 100644 --- a/lib/increase/models/real_time_payments_transfer_retrieve_params.rb +++ b/lib/increase/models/real_time_payments_transfer_retrieve_params.rb @@ -4,16 +4,11 @@ module Increase module Models # @see Increase::Resources::RealTimePaymentsTransfers#retrieve class RealTimePaymentsTransferRetrieveParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters - # @!parse - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(request_options: {}, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(request_options: {}) + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/increase/models/routing_number_list_params.rb b/lib/increase/models/routing_number_list_params.rb index c1ff5dbf0..ff4221e67 100644 --- a/lib/increase/models/routing_number_list_params.rb +++ b/lib/increase/models/routing_number_list_params.rb @@ -4,8 +4,7 @@ module Increase module Models # @see Increase::Resources::RoutingNumbers#list class RoutingNumberListParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters # @!attribute routing_number @@ -14,36 +13,24 @@ class RoutingNumberListParams < Increase::Internal::Type::BaseModel # @return [String] required :routing_number, String - # @!attribute [r] cursor + # @!attribute cursor # Return the page of entries after this one. # # @return [String, nil] optional :cursor, String - # @!parse - # # @return [String] - # attr_writer :cursor - - # @!attribute [r] limit + # @!attribute limit # Limit the size of the list that is returned. The default (and maximum) is 100 # objects. # # @return [Integer, nil] optional :limit, Integer - # @!parse - # # @return [Integer] - # attr_writer :limit - - # @!parse - # # @param routing_number [String] - # # @param cursor [String] - # # @param limit [Integer] - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(routing_number:, cursor: nil, limit: nil, request_options: {}, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(routing_number:, cursor: nil, limit: nil, request_options: {}) + # @param routing_number [String] + # @param cursor [String] + # @param limit [Integer] + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/increase/models/routing_number_list_response.rb b/lib/increase/models/routing_number_list_response.rb index ab1e89ef6..6b996f421 100644 --- a/lib/increase/models/routing_number_list_response.rb +++ b/lib/increase/models/routing_number_list_response.rb @@ -42,19 +42,15 @@ class RoutingNumberListResponse < Increase::Internal::Type::BaseModel # @return [Symbol, Increase::Models::RoutingNumberListResponse::WireTransfers] required :wire_transfers, enum: -> { Increase::Models::RoutingNumberListResponse::WireTransfers } - # @!parse - # # Routing numbers are used to identify your bank in a financial transaction. - # # - # # @param ach_transfers [Symbol, Increase::Models::RoutingNumberListResponse::ACHTransfers] - # # @param name [String] - # # @param real_time_payments_transfers [Symbol, Increase::Models::RoutingNumberListResponse::RealTimePaymentsTransfers] - # # @param routing_number [String] - # # @param type [Symbol, Increase::Models::RoutingNumberListResponse::Type] - # # @param wire_transfers [Symbol, Increase::Models::RoutingNumberListResponse::WireTransfers] - # # - # def initialize(ach_transfers:, name:, real_time_payments_transfers:, routing_number:, type:, wire_transfers:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(ach_transfers:, name:, real_time_payments_transfers:, routing_number:, type:, wire_transfers:) + # Routing numbers are used to identify your bank in a financial transaction. + # + # @param ach_transfers [Symbol, Increase::Models::RoutingNumberListResponse::ACHTransfers] + # @param name [String] + # @param real_time_payments_transfers [Symbol, Increase::Models::RoutingNumberListResponse::RealTimePaymentsTransfers] + # @param routing_number [String] + # @param type [Symbol, Increase::Models::RoutingNumberListResponse::Type] + # @param wire_transfers [Symbol, Increase::Models::RoutingNumberListResponse::WireTransfers] # This routing number's support for ACH Transfers. # @@ -68,11 +64,8 @@ module ACHTransfers # The routing number cannot receive this transfer type. NOT_SUPPORTED = :not_supported - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # This routing number's support for Real-Time Payments Transfers. @@ -87,11 +80,8 @@ module RealTimePaymentsTransfers # The routing number cannot receive this transfer type. NOT_SUPPORTED = :not_supported - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # A constant representing the object's type. For this resource it will always be @@ -103,11 +93,8 @@ module Type ROUTING_NUMBER = :routing_number - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # This routing number's support for Wire Transfers. @@ -122,11 +109,8 @@ module WireTransfers # The routing number cannot receive this transfer type. NOT_SUPPORTED = :not_supported - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end diff --git a/lib/increase/models/simulations/account_statement_create_params.rb b/lib/increase/models/simulations/account_statement_create_params.rb index 2cb25a796..96af7d481 100644 --- a/lib/increase/models/simulations/account_statement_create_params.rb +++ b/lib/increase/models/simulations/account_statement_create_params.rb @@ -5,8 +5,7 @@ module Models module Simulations # @see Increase::Resources::Simulations::AccountStatements#create class AccountStatementCreateParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters # @!attribute account_id @@ -15,13 +14,9 @@ class AccountStatementCreateParams < Increase::Internal::Type::BaseModel # @return [String] required :account_id, String - # @!parse - # # @param account_id [String] - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(account_id:, request_options: {}, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(account_id:, request_options: {}) + # @param account_id [String] + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/increase/models/simulations/account_transfer_complete_params.rb b/lib/increase/models/simulations/account_transfer_complete_params.rb index 12cbe7855..f768ef232 100644 --- a/lib/increase/models/simulations/account_transfer_complete_params.rb +++ b/lib/increase/models/simulations/account_transfer_complete_params.rb @@ -5,16 +5,11 @@ module Models module Simulations # @see Increase::Resources::Simulations::AccountTransfers#complete class AccountTransferCompleteParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters - # @!parse - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(request_options: {}, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(request_options: {}) + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/increase/models/simulations/ach_transfer_acknowledge_params.rb b/lib/increase/models/simulations/ach_transfer_acknowledge_params.rb index 0897f510c..008933d5e 100644 --- a/lib/increase/models/simulations/ach_transfer_acknowledge_params.rb +++ b/lib/increase/models/simulations/ach_transfer_acknowledge_params.rb @@ -5,16 +5,11 @@ module Models module Simulations # @see Increase::Resources::Simulations::ACHTransfers#acknowledge class ACHTransferAcknowledgeParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters - # @!parse - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(request_options: {}, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(request_options: {}) + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/increase/models/simulations/ach_transfer_create_notification_of_change_params.rb b/lib/increase/models/simulations/ach_transfer_create_notification_of_change_params.rb index c67a7635d..21a89ac4d 100644 --- a/lib/increase/models/simulations/ach_transfer_create_notification_of_change_params.rb +++ b/lib/increase/models/simulations/ach_transfer_create_notification_of_change_params.rb @@ -5,8 +5,7 @@ module Models module Simulations # @see Increase::Resources::Simulations::ACHTransfers#create_notification_of_change class ACHTransferCreateNotificationOfChangeParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters # @!attribute change_code @@ -22,14 +21,10 @@ class ACHTransferCreateNotificationOfChangeParams < Increase::Internal::Type::Ba # @return [String] required :corrected_data, String - # @!parse - # # @param change_code [Symbol, Increase::Models::Simulations::ACHTransferCreateNotificationOfChangeParams::ChangeCode] - # # @param corrected_data [String] - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(change_code:, corrected_data:, request_options: {}, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(change_code:, corrected_data:, request_options: {}) + # @param change_code [Symbol, Increase::Models::Simulations::ACHTransferCreateNotificationOfChangeParams::ChangeCode] + # @param corrected_data [String] + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] # The reason for the notification of change. module ChangeCode @@ -98,11 +93,8 @@ module ChangeCode INCORRECT_TRANSACTION_CODE_BY_ORIGINATING_DEPOSITORY_FINANCIAL_INSTITUTION = :incorrect_transaction_code_by_originating_depository_financial_institution - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end diff --git a/lib/increase/models/simulations/ach_transfer_return_params.rb b/lib/increase/models/simulations/ach_transfer_return_params.rb index ab339b883..e37339850 100644 --- a/lib/increase/models/simulations/ach_transfer_return_params.rb +++ b/lib/increase/models/simulations/ach_transfer_return_params.rb @@ -5,28 +5,19 @@ module Models module Simulations # @see Increase::Resources::Simulations::ACHTransfers#return_ class ACHTransferReturnParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters - # @!attribute [r] reason + # @!attribute reason # The reason why the Federal Reserve or destination bank returned this transfer. # Defaults to `no_account`. # # @return [Symbol, Increase::Models::Simulations::ACHTransferReturnParams::Reason, nil] optional :reason, enum: -> { Increase::Models::Simulations::ACHTransferReturnParams::Reason } - # @!parse - # # @return [Symbol, Increase::Models::Simulations::ACHTransferReturnParams::Reason] - # attr_writer :reason - - # @!parse - # # @param reason [Symbol, Increase::Models::Simulations::ACHTransferReturnParams::Reason] - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(reason: nil, request_options: {}, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(reason: nil, request_options: {}) + # @param reason [Symbol, Increase::Models::Simulations::ACHTransferReturnParams::Reason] + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] # The reason why the Federal Reserve or destination bank returned this transfer. # Defaults to `no_account`. @@ -246,11 +237,8 @@ module Reason # Code R68. A rare return reason. The return was sent too late. UNTIMELY_RETURN = :untimely_return - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end diff --git a/lib/increase/models/simulations/ach_transfer_settle_params.rb b/lib/increase/models/simulations/ach_transfer_settle_params.rb index 94a7c3f06..e96d1cba2 100644 --- a/lib/increase/models/simulations/ach_transfer_settle_params.rb +++ b/lib/increase/models/simulations/ach_transfer_settle_params.rb @@ -5,16 +5,11 @@ module Models module Simulations # @see Increase::Resources::Simulations::ACHTransfers#settle class ACHTransferSettleParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters - # @!parse - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(request_options: {}, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(request_options: {}) + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/increase/models/simulations/ach_transfer_submit_params.rb b/lib/increase/models/simulations/ach_transfer_submit_params.rb index 81f224d51..eb625f0a0 100644 --- a/lib/increase/models/simulations/ach_transfer_submit_params.rb +++ b/lib/increase/models/simulations/ach_transfer_submit_params.rb @@ -5,16 +5,11 @@ module Models module Simulations # @see Increase::Resources::Simulations::ACHTransfers#submit class ACHTransferSubmitParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters - # @!parse - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(request_options: {}, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(request_options: {}) + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/increase/models/simulations/card_authorization_create_params.rb b/lib/increase/models/simulations/card_authorization_create_params.rb index 18513006a..97d38045e 100644 --- a/lib/increase/models/simulations/card_authorization_create_params.rb +++ b/lib/increase/models/simulations/card_authorization_create_params.rb @@ -5,8 +5,7 @@ module Models module Simulations # @see Increase::Resources::Simulations::CardAuthorizations#create class CardAuthorizationCreateParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters # @!attribute amount @@ -15,28 +14,20 @@ class CardAuthorizationCreateParams < Increase::Internal::Type::BaseModel # @return [Integer] required :amount, Integer - # @!attribute [r] authenticated_card_payment_id + # @!attribute authenticated_card_payment_id # The identifier of a Card Payment with a `card_authentication` if you want to # simulate an authenticated authorization. # # @return [String, nil] optional :authenticated_card_payment_id, String - # @!parse - # # @return [String] - # attr_writer :authenticated_card_payment_id - - # @!attribute [r] card_id + # @!attribute card_id # The identifier of the Card to be authorized. # # @return [String, nil] optional :card_id, String - # @!parse - # # @return [String] - # attr_writer :card_id - - # @!attribute [r] decline_reason + # @!attribute decline_reason # Forces a card decline with a specific reason. No real time decision will be # sent. # @@ -44,32 +35,20 @@ class CardAuthorizationCreateParams < Increase::Internal::Type::BaseModel optional :decline_reason, enum: -> { Increase::Models::Simulations::CardAuthorizationCreateParams::DeclineReason } - # @!parse - # # @return [Symbol, Increase::Models::Simulations::CardAuthorizationCreateParams::DeclineReason] - # attr_writer :decline_reason - - # @!attribute [r] digital_wallet_token_id + # @!attribute digital_wallet_token_id # The identifier of the Digital Wallet Token to be authorized. # # @return [String, nil] optional :digital_wallet_token_id, String - # @!parse - # # @return [String] - # attr_writer :digital_wallet_token_id - - # @!attribute [r] direction + # @!attribute direction # The direction describes the direction the funds will move, either from the # cardholder to the merchant or from the merchant to the cardholder. # # @return [Symbol, Increase::Models::Simulations::CardAuthorizationCreateParams::Direction, nil] optional :direction, enum: -> { Increase::Models::Simulations::CardAuthorizationCreateParams::Direction } - # @!parse - # # @return [Symbol, Increase::Models::Simulations::CardAuthorizationCreateParams::Direction] - # attr_writer :direction - - # @!attribute [r] event_subscription_id + # @!attribute event_subscription_id # The identifier of the Event Subscription to use. If provided, will override the # default real time event subscription. Because you can only create one real time # decision event subscription, you can use this field to route events to any @@ -78,160 +57,90 @@ class CardAuthorizationCreateParams < Increase::Internal::Type::BaseModel # @return [String, nil] optional :event_subscription_id, String - # @!parse - # # @return [String] - # attr_writer :event_subscription_id - - # @!attribute [r] merchant_acceptor_id + # @!attribute merchant_acceptor_id # The merchant identifier (commonly abbreviated as MID) of the merchant the card # is transacting with. # # @return [String, nil] optional :merchant_acceptor_id, String - # @!parse - # # @return [String] - # attr_writer :merchant_acceptor_id - - # @!attribute [r] merchant_category_code + # @!attribute merchant_category_code # The Merchant Category Code (commonly abbreviated as MCC) of the merchant the # card is transacting with. # # @return [String, nil] optional :merchant_category_code, String - # @!parse - # # @return [String] - # attr_writer :merchant_category_code - - # @!attribute [r] merchant_city + # @!attribute merchant_city # The city the merchant resides in. # # @return [String, nil] optional :merchant_city, String - # @!parse - # # @return [String] - # attr_writer :merchant_city - - # @!attribute [r] merchant_country + # @!attribute merchant_country # The country the merchant resides in. # # @return [String, nil] optional :merchant_country, String - # @!parse - # # @return [String] - # attr_writer :merchant_country - - # @!attribute [r] merchant_descriptor + # @!attribute merchant_descriptor # The merchant descriptor of the merchant the card is transacting with. # # @return [String, nil] optional :merchant_descriptor, String - # @!parse - # # @return [String] - # attr_writer :merchant_descriptor - - # @!attribute [r] merchant_state + # @!attribute merchant_state # The state the merchant resides in. # # @return [String, nil] optional :merchant_state, String - # @!parse - # # @return [String] - # attr_writer :merchant_state - - # @!attribute [r] network_details + # @!attribute network_details # Fields specific to a given card network. # # @return [Increase::Models::Simulations::CardAuthorizationCreateParams::NetworkDetails, nil] optional :network_details, -> { Increase::Models::Simulations::CardAuthorizationCreateParams::NetworkDetails } - # @!parse - # # @return [Increase::Models::Simulations::CardAuthorizationCreateParams::NetworkDetails] - # attr_writer :network_details - - # @!attribute [r] network_risk_score + # @!attribute network_risk_score # The risk score generated by the card network. For Visa this is the Visa Advanced # Authorization risk score, from 0 to 99, where 99 is the riskiest. # # @return [Integer, nil] optional :network_risk_score, Integer - # @!parse - # # @return [Integer] - # attr_writer :network_risk_score - - # @!attribute [r] physical_card_id + # @!attribute physical_card_id # The identifier of the Physical Card to be authorized. # # @return [String, nil] optional :physical_card_id, String - # @!parse - # # @return [String] - # attr_writer :physical_card_id - - # @!attribute [r] terminal_id + # @!attribute terminal_id # The terminal identifier (commonly abbreviated as TID) of the terminal the card # is transacting with. # # @return [String, nil] optional :terminal_id, String - # @!parse - # # @return [String] - # attr_writer :terminal_id - - # @!parse - # # @param amount [Integer] - # # @param authenticated_card_payment_id [String] - # # @param card_id [String] - # # @param decline_reason [Symbol, Increase::Models::Simulations::CardAuthorizationCreateParams::DeclineReason] - # # @param digital_wallet_token_id [String] - # # @param direction [Symbol, Increase::Models::Simulations::CardAuthorizationCreateParams::Direction] - # # @param event_subscription_id [String] - # # @param merchant_acceptor_id [String] - # # @param merchant_category_code [String] - # # @param merchant_city [String] - # # @param merchant_country [String] - # # @param merchant_descriptor [String] - # # @param merchant_state [String] - # # @param network_details [Increase::Models::Simulations::CardAuthorizationCreateParams::NetworkDetails] - # # @param network_risk_score [Integer] - # # @param physical_card_id [String] - # # @param terminal_id [String] - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize( - # amount:, - # authenticated_card_payment_id: nil, - # card_id: nil, - # decline_reason: nil, - # digital_wallet_token_id: nil, - # direction: nil, - # event_subscription_id: nil, - # merchant_acceptor_id: nil, - # merchant_category_code: nil, - # merchant_city: nil, - # merchant_country: nil, - # merchant_descriptor: nil, - # merchant_state: nil, - # network_details: nil, - # network_risk_score: nil, - # physical_card_id: nil, - # terminal_id: nil, - # request_options: {}, - # ** - # ) - # super - # end - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(amount:, authenticated_card_payment_id: nil, card_id: nil, decline_reason: nil, digital_wallet_token_id: nil, direction: nil, event_subscription_id: nil, merchant_acceptor_id: nil, merchant_category_code: nil, merchant_city: nil, merchant_country: nil, merchant_descriptor: nil, merchant_state: nil, network_details: nil, network_risk_score: nil, physical_card_id: nil, terminal_id: nil, request_options: {}) + # @param amount [Integer] + # @param authenticated_card_payment_id [String] + # @param card_id [String] + # @param decline_reason [Symbol, Increase::Models::Simulations::CardAuthorizationCreateParams::DeclineReason] + # @param digital_wallet_token_id [String] + # @param direction [Symbol, Increase::Models::Simulations::CardAuthorizationCreateParams::Direction] + # @param event_subscription_id [String] + # @param merchant_acceptor_id [String] + # @param merchant_category_code [String] + # @param merchant_city [String] + # @param merchant_country [String] + # @param merchant_descriptor [String] + # @param merchant_state [String] + # @param network_details [Increase::Models::Simulations::CardAuthorizationCreateParams::NetworkDetails] + # @param network_risk_score [Integer] + # @param physical_card_id [String] + # @param terminal_id [String] + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] # Forces a card decline with a specific reason. No real time decision will be # sent. @@ -286,14 +195,14 @@ module DeclineReason # The original card authorization for this incremental authorization does not exist. MISSING_ORIGINAL_AUTHORIZATION = :missing_original_authorization + # The transaction was declined because the 3DS authentication failed. + FAILED_3DS_AUTHENTICATION = :failed_3ds_authentication + # The transaction was suspected to be fraudulent. Please reach out to support@increase.com for more information. SUSPECTED_FRAUD = :suspected_fraud - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # The direction describes the direction the funds will move, either from the @@ -307,11 +216,8 @@ module Direction # A refund card authorization, sometimes referred to as a credit voucher authorization, where funds are credited to the cardholder. REFUND = :refund - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end class NetworkDetails < Increase::Internal::Type::BaseModel @@ -321,36 +227,24 @@ class NetworkDetails < Increase::Internal::Type::BaseModel # @return [Increase::Models::Simulations::CardAuthorizationCreateParams::NetworkDetails::Visa] required :visa, -> { Increase::Models::Simulations::CardAuthorizationCreateParams::NetworkDetails::Visa } - # @!parse - # # Fields specific to a given card network. - # # - # # @param visa [Increase::Models::Simulations::CardAuthorizationCreateParams::NetworkDetails::Visa] - # # - # def initialize(visa:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(visa:) + # Fields specific to a given card network. + # + # @param visa [Increase::Models::Simulations::CardAuthorizationCreateParams::NetworkDetails::Visa] # @see Increase::Models::Simulations::CardAuthorizationCreateParams::NetworkDetails#visa class Visa < Increase::Internal::Type::BaseModel - # @!attribute [r] stand_in_processing_reason + # @!attribute stand_in_processing_reason # The reason code for the stand-in processing. # # @return [Symbol, Increase::Models::Simulations::CardAuthorizationCreateParams::NetworkDetails::Visa::StandInProcessingReason, nil] optional :stand_in_processing_reason, enum: -> { Increase::Models::Simulations::CardAuthorizationCreateParams::NetworkDetails::Visa::StandInProcessingReason } - # @!parse - # # @return [Symbol, Increase::Models::Simulations::CardAuthorizationCreateParams::NetworkDetails::Visa::StandInProcessingReason] - # attr_writer :stand_in_processing_reason - - # @!parse - # # Fields specific to the Visa network. - # # - # # @param stand_in_processing_reason [Symbol, Increase::Models::Simulations::CardAuthorizationCreateParams::NetworkDetails::Visa::StandInProcessingReason] - # # - # def initialize(stand_in_processing_reason: nil, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(stand_in_processing_reason: nil) + # Fields specific to the Visa network. + # + # @param stand_in_processing_reason [Symbol, Increase::Models::Simulations::CardAuthorizationCreateParams::NetworkDetails::Visa::StandInProcessingReason] # The reason code for the stand-in processing. # @@ -381,11 +275,8 @@ module StandInProcessingReason # An unspecific reason for stand-in processing. OTHER = :other - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end diff --git a/lib/increase/models/simulations/card_authorization_create_response.rb b/lib/increase/models/simulations/card_authorization_create_response.rb index 31306a64d..f6cfb0baf 100644 --- a/lib/increase/models/simulations/card_authorization_create_response.rb +++ b/lib/increase/models/simulations/card_authorization_create_response.rb @@ -28,16 +28,12 @@ class CardAuthorizationCreateResponse < Increase::Internal::Type::BaseModel # @return [Symbol, Increase::Models::Simulations::CardAuthorizationCreateResponse::Type] required :type, enum: -> { Increase::Models::Simulations::CardAuthorizationCreateResponse::Type } - # @!parse - # # The results of a Card Authorization simulation. - # # - # # @param declined_transaction [Increase::Models::DeclinedTransaction, nil] - # # @param pending_transaction [Increase::Models::PendingTransaction, nil] - # # @param type [Symbol, Increase::Models::Simulations::CardAuthorizationCreateResponse::Type] - # # - # def initialize(declined_transaction:, pending_transaction:, type:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(declined_transaction:, pending_transaction:, type:) + # The results of a Card Authorization simulation. + # + # @param declined_transaction [Increase::Models::DeclinedTransaction, nil] + # @param pending_transaction [Increase::Models::PendingTransaction, nil] + # @param type [Symbol, Increase::Models::Simulations::CardAuthorizationCreateResponse::Type] # A constant representing the object's type. For this resource it will always be # `inbound_card_authorization_simulation_result`. @@ -48,11 +44,8 @@ module Type INBOUND_CARD_AUTHORIZATION_SIMULATION_RESULT = :inbound_card_authorization_simulation_result - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end diff --git a/lib/increase/models/simulations/card_authorization_expiration_create_params.rb b/lib/increase/models/simulations/card_authorization_expiration_create_params.rb index 419ade855..5100d9593 100644 --- a/lib/increase/models/simulations/card_authorization_expiration_create_params.rb +++ b/lib/increase/models/simulations/card_authorization_expiration_create_params.rb @@ -5,8 +5,7 @@ module Models module Simulations # @see Increase::Resources::Simulations::CardAuthorizationExpirations#create class CardAuthorizationExpirationCreateParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters # @!attribute card_payment_id @@ -15,13 +14,9 @@ class CardAuthorizationExpirationCreateParams < Increase::Internal::Type::BaseMo # @return [String] required :card_payment_id, String - # @!parse - # # @param card_payment_id [String] - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(card_payment_id:, request_options: {}, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(card_payment_id:, request_options: {}) + # @param card_payment_id [String] + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/increase/models/simulations/card_dispute_action_params.rb b/lib/increase/models/simulations/card_dispute_action_params.rb index 6a8890a2a..8c5b2e7d7 100644 --- a/lib/increase/models/simulations/card_dispute_action_params.rb +++ b/lib/increase/models/simulations/card_dispute_action_params.rb @@ -5,8 +5,7 @@ module Models module Simulations # @see Increase::Resources::Simulations::CardDisputes#action class CardDisputeActionParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters # @!attribute status @@ -15,24 +14,16 @@ class CardDisputeActionParams < Increase::Internal::Type::BaseModel # @return [Symbol, Increase::Models::Simulations::CardDisputeActionParams::Status] required :status, enum: -> { Increase::Models::Simulations::CardDisputeActionParams::Status } - # @!attribute [r] explanation + # @!attribute explanation # Why the dispute was rejected. Not required for accepting disputes. # # @return [String, nil] optional :explanation, String - # @!parse - # # @return [String] - # attr_writer :explanation - - # @!parse - # # @param status [Symbol, Increase::Models::Simulations::CardDisputeActionParams::Status] - # # @param explanation [String] - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(status:, explanation: nil, request_options: {}, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(status:, explanation: nil, request_options: {}) + # @param status [Symbol, Increase::Models::Simulations::CardDisputeActionParams::Status] + # @param explanation [String] + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] # The status to move the dispute to. module Status @@ -53,11 +44,8 @@ module Status # The Card Dispute has been won and no further action can be taken. WON = :won - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end diff --git a/lib/increase/models/simulations/card_fuel_confirmation_create_params.rb b/lib/increase/models/simulations/card_fuel_confirmation_create_params.rb index 861c5829b..d984c0f97 100644 --- a/lib/increase/models/simulations/card_fuel_confirmation_create_params.rb +++ b/lib/increase/models/simulations/card_fuel_confirmation_create_params.rb @@ -5,8 +5,7 @@ module Models module Simulations # @see Increase::Resources::Simulations::CardFuelConfirmations#create class CardFuelConfirmationCreateParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters # @!attribute amount @@ -22,14 +21,10 @@ class CardFuelConfirmationCreateParams < Increase::Internal::Type::BaseModel # @return [String] required :card_payment_id, String - # @!parse - # # @param amount [Integer] - # # @param card_payment_id [String] - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(amount:, card_payment_id:, request_options: {}, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(amount:, card_payment_id:, request_options: {}) + # @param amount [Integer] + # @param card_payment_id [String] + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/increase/models/simulations/card_increment_create_params.rb b/lib/increase/models/simulations/card_increment_create_params.rb index 9a3c50cea..b16edcf70 100644 --- a/lib/increase/models/simulations/card_increment_create_params.rb +++ b/lib/increase/models/simulations/card_increment_create_params.rb @@ -5,8 +5,7 @@ module Models module Simulations # @see Increase::Resources::Simulations::CardIncrements#create class CardIncrementCreateParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters # @!attribute amount @@ -21,7 +20,7 @@ class CardIncrementCreateParams < Increase::Internal::Type::BaseModel # @return [String] required :card_payment_id, String - # @!attribute [r] event_subscription_id + # @!attribute event_subscription_id # The identifier of the Event Subscription to use. If provided, will override the # default real time event subscription. Because you can only create one real time # decision event subscription, you can use this field to route events to any @@ -30,19 +29,11 @@ class CardIncrementCreateParams < Increase::Internal::Type::BaseModel # @return [String, nil] optional :event_subscription_id, String - # @!parse - # # @return [String] - # attr_writer :event_subscription_id - - # @!parse - # # @param amount [Integer] - # # @param card_payment_id [String] - # # @param event_subscription_id [String] - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(amount:, card_payment_id:, event_subscription_id: nil, request_options: {}, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(amount:, card_payment_id:, event_subscription_id: nil, request_options: {}) + # @param amount [Integer] + # @param card_payment_id [String] + # @param event_subscription_id [String] + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/increase/models/simulations/card_refund_create_params.rb b/lib/increase/models/simulations/card_refund_create_params.rb index 5bd23c9b6..2cdcf2142 100644 --- a/lib/increase/models/simulations/card_refund_create_params.rb +++ b/lib/increase/models/simulations/card_refund_create_params.rb @@ -5,8 +5,7 @@ module Models module Simulations # @see Increase::Resources::Simulations::CardRefunds#create class CardRefundCreateParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters # @!attribute transaction_id @@ -16,13 +15,9 @@ class CardRefundCreateParams < Increase::Internal::Type::BaseModel # @return [String] required :transaction_id, String - # @!parse - # # @param transaction_id [String] - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(transaction_id:, request_options: {}, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(transaction_id:, request_options: {}) + # @param transaction_id [String] + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/increase/models/simulations/card_reversal_create_params.rb b/lib/increase/models/simulations/card_reversal_create_params.rb index 8a13291c5..aa32b9422 100644 --- a/lib/increase/models/simulations/card_reversal_create_params.rb +++ b/lib/increase/models/simulations/card_reversal_create_params.rb @@ -5,8 +5,7 @@ module Models module Simulations # @see Increase::Resources::Simulations::CardReversals#create class CardReversalCreateParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters # @!attribute card_payment_id @@ -15,25 +14,17 @@ class CardReversalCreateParams < Increase::Internal::Type::BaseModel # @return [String] required :card_payment_id, String - # @!attribute [r] amount + # @!attribute amount # The amount of the reversal in minor units in the card authorization's currency. # This defaults to the authorization amount. # # @return [Integer, nil] optional :amount, Integer - # @!parse - # # @return [Integer] - # attr_writer :amount - - # @!parse - # # @param card_payment_id [String] - # # @param amount [Integer] - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(card_payment_id:, amount: nil, request_options: {}, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(card_payment_id:, amount: nil, request_options: {}) + # @param card_payment_id [String] + # @param amount [Integer] + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/increase/models/simulations/card_settlement_create_params.rb b/lib/increase/models/simulations/card_settlement_create_params.rb index 242fde61b..1ae193b5a 100644 --- a/lib/increase/models/simulations/card_settlement_create_params.rb +++ b/lib/increase/models/simulations/card_settlement_create_params.rb @@ -5,8 +5,7 @@ module Models module Simulations # @see Increase::Resources::Simulations::CardSettlements#create class CardSettlementCreateParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters # @!attribute card_id @@ -22,26 +21,18 @@ class CardSettlementCreateParams < Increase::Internal::Type::BaseModel # @return [String] required :pending_transaction_id, String - # @!attribute [r] amount + # @!attribute amount # The amount to be settled. This defaults to the amount of the Pending Transaction # being settled. # # @return [Integer, nil] optional :amount, Integer - # @!parse - # # @return [Integer] - # attr_writer :amount - - # @!parse - # # @param card_id [String] - # # @param pending_transaction_id [String] - # # @param amount [Integer] - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(card_id:, pending_transaction_id:, amount: nil, request_options: {}, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(card_id:, pending_transaction_id:, amount: nil, request_options: {}) + # @param card_id [String] + # @param pending_transaction_id [String] + # @param amount [Integer] + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/increase/models/simulations/check_deposit_reject_params.rb b/lib/increase/models/simulations/check_deposit_reject_params.rb index b22f45b31..73b9af4cc 100644 --- a/lib/increase/models/simulations/check_deposit_reject_params.rb +++ b/lib/increase/models/simulations/check_deposit_reject_params.rb @@ -5,16 +5,11 @@ module Models module Simulations # @see Increase::Resources::Simulations::CheckDeposits#reject class CheckDepositRejectParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters - # @!parse - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(request_options: {}, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(request_options: {}) + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/increase/models/simulations/check_deposit_return_params.rb b/lib/increase/models/simulations/check_deposit_return_params.rb index 3e212ad2d..0b65aba30 100644 --- a/lib/increase/models/simulations/check_deposit_return_params.rb +++ b/lib/increase/models/simulations/check_deposit_return_params.rb @@ -5,16 +5,11 @@ module Models module Simulations # @see Increase::Resources::Simulations::CheckDeposits#return_ class CheckDepositReturnParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters - # @!parse - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(request_options: {}, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(request_options: {}) + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/increase/models/simulations/check_deposit_submit_params.rb b/lib/increase/models/simulations/check_deposit_submit_params.rb index 9ced014d7..6a7041a67 100644 --- a/lib/increase/models/simulations/check_deposit_submit_params.rb +++ b/lib/increase/models/simulations/check_deposit_submit_params.rb @@ -5,16 +5,11 @@ module Models module Simulations # @see Increase::Resources::Simulations::CheckDeposits#submit class CheckDepositSubmitParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters - # @!parse - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(request_options: {}, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(request_options: {}) + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/increase/models/simulations/check_transfer_mail_params.rb b/lib/increase/models/simulations/check_transfer_mail_params.rb index a75f677b4..5c2228bfd 100644 --- a/lib/increase/models/simulations/check_transfer_mail_params.rb +++ b/lib/increase/models/simulations/check_transfer_mail_params.rb @@ -5,16 +5,11 @@ module Models module Simulations # @see Increase::Resources::Simulations::CheckTransfers#mail class CheckTransferMailParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters - # @!parse - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(request_options: {}, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(request_options: {}) + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/increase/models/simulations/digital_wallet_token_request_create_params.rb b/lib/increase/models/simulations/digital_wallet_token_request_create_params.rb index 7a98e29c3..f0dd14002 100644 --- a/lib/increase/models/simulations/digital_wallet_token_request_create_params.rb +++ b/lib/increase/models/simulations/digital_wallet_token_request_create_params.rb @@ -5,8 +5,7 @@ module Models module Simulations # @see Increase::Resources::Simulations::DigitalWalletTokenRequests#create class DigitalWalletTokenRequestCreateParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters # @!attribute card_id @@ -15,13 +14,9 @@ class DigitalWalletTokenRequestCreateParams < Increase::Internal::Type::BaseMode # @return [String] required :card_id, String - # @!parse - # # @param card_id [String] - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(card_id:, request_options: {}, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(card_id:, request_options: {}) + # @param card_id [String] + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/increase/models/simulations/digital_wallet_token_request_create_response.rb b/lib/increase/models/simulations/digital_wallet_token_request_create_response.rb index 3a7445b8f..63c25dbc0 100644 --- a/lib/increase/models/simulations/digital_wallet_token_request_create_response.rb +++ b/lib/increase/models/simulations/digital_wallet_token_request_create_response.rb @@ -28,16 +28,12 @@ class DigitalWalletTokenRequestCreateResponse < Increase::Internal::Type::BaseMo # @return [Symbol, Increase::Models::Simulations::DigitalWalletTokenRequestCreateResponse::Type] required :type, enum: -> { Increase::Models::Simulations::DigitalWalletTokenRequestCreateResponse::Type } - # @!parse - # # The results of a Digital Wallet Token simulation. - # # - # # @param decline_reason [Symbol, Increase::Models::Simulations::DigitalWalletTokenRequestCreateResponse::DeclineReason, nil] - # # @param digital_wallet_token_id [String, nil] - # # @param type [Symbol, Increase::Models::Simulations::DigitalWalletTokenRequestCreateResponse::Type] - # # - # def initialize(decline_reason:, digital_wallet_token_id:, type:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(decline_reason:, digital_wallet_token_id:, type:) + # The results of a Digital Wallet Token simulation. + # + # @param decline_reason [Symbol, Increase::Models::Simulations::DigitalWalletTokenRequestCreateResponse::DeclineReason, nil] + # @param digital_wallet_token_id [String, nil] + # @param type [Symbol, Increase::Models::Simulations::DigitalWalletTokenRequestCreateResponse::Type] # If the simulated tokenization attempt was declined, this field contains details # as to why. @@ -58,11 +54,8 @@ module DeclineReason # Your webhook declined the token provisioning attempt. WEBHOOK_DECLINED = :webhook_declined - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # A constant representing the object's type. For this resource it will always be @@ -75,11 +68,8 @@ module Type INBOUND_DIGITAL_WALLET_TOKEN_REQUEST_SIMULATION_RESULT = :inbound_digital_wallet_token_request_simulation_result - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end diff --git a/lib/increase/models/simulations/document_create_params.rb b/lib/increase/models/simulations/document_create_params.rb index 4638603b1..540ab13ca 100644 --- a/lib/increase/models/simulations/document_create_params.rb +++ b/lib/increase/models/simulations/document_create_params.rb @@ -5,8 +5,7 @@ module Models module Simulations # @see Increase::Resources::Simulations::Documents#create class DocumentCreateParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters # @!attribute account_id @@ -15,13 +14,9 @@ class DocumentCreateParams < Increase::Internal::Type::BaseModel # @return [String] required :account_id, String - # @!parse - # # @param account_id [String] - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(account_id:, request_options: {}, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(account_id:, request_options: {}) + # @param account_id [String] + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/increase/models/simulations/inbound_ach_transfer_create_params.rb b/lib/increase/models/simulations/inbound_ach_transfer_create_params.rb index c9b47710d..e4233385b 100644 --- a/lib/increase/models/simulations/inbound_ach_transfer_create_params.rb +++ b/lib/increase/models/simulations/inbound_ach_transfer_create_params.rb @@ -5,8 +5,7 @@ module Models module Simulations # @see Increase::Resources::Simulations::InboundACHTransfers#create class InboundACHTransferCreateParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters # @!attribute account_number_id @@ -23,131 +22,75 @@ class InboundACHTransferCreateParams < Increase::Internal::Type::BaseModel # @return [Integer] required :amount, Integer - # @!attribute [r] company_descriptive_date + # @!attribute company_descriptive_date # The description of the date of the transfer. # # @return [String, nil] optional :company_descriptive_date, String - # @!parse - # # @return [String] - # attr_writer :company_descriptive_date - - # @!attribute [r] company_discretionary_data + # @!attribute company_discretionary_data # Data associated with the transfer set by the sender. # # @return [String, nil] optional :company_discretionary_data, String - # @!parse - # # @return [String] - # attr_writer :company_discretionary_data - - # @!attribute [r] company_entry_description + # @!attribute company_entry_description # The description of the transfer set by the sender. # # @return [String, nil] optional :company_entry_description, String - # @!parse - # # @return [String] - # attr_writer :company_entry_description - - # @!attribute [r] company_id + # @!attribute company_id # The sender's company ID. # # @return [String, nil] optional :company_id, String - # @!parse - # # @return [String] - # attr_writer :company_id - - # @!attribute [r] company_name + # @!attribute company_name # The name of the sender. # # @return [String, nil] optional :company_name, String - # @!parse - # # @return [String] - # attr_writer :company_name - - # @!attribute [r] receiver_id_number + # @!attribute receiver_id_number # The ID of the receiver of the transfer. # # @return [String, nil] optional :receiver_id_number, String - # @!parse - # # @return [String] - # attr_writer :receiver_id_number - - # @!attribute [r] receiver_name + # @!attribute receiver_name # The name of the receiver of the transfer. # # @return [String, nil] optional :receiver_name, String - # @!parse - # # @return [String] - # attr_writer :receiver_name - - # @!attribute [r] resolve_at + # @!attribute resolve_at # The time at which the transfer should be resolved. If not provided will resolve # immediately. # # @return [Time, nil] optional :resolve_at, Time - # @!parse - # # @return [Time] - # attr_writer :resolve_at - - # @!attribute [r] standard_entry_class_code + # @!attribute standard_entry_class_code # The standard entry class code for the transfer. # # @return [Symbol, Increase::Models::Simulations::InboundACHTransferCreateParams::StandardEntryClassCode, nil] optional :standard_entry_class_code, enum: -> { Increase::Models::Simulations::InboundACHTransferCreateParams::StandardEntryClassCode } - # @!parse - # # @return [Symbol, Increase::Models::Simulations::InboundACHTransferCreateParams::StandardEntryClassCode] - # attr_writer :standard_entry_class_code - - # @!parse - # # @param account_number_id [String] - # # @param amount [Integer] - # # @param company_descriptive_date [String] - # # @param company_discretionary_data [String] - # # @param company_entry_description [String] - # # @param company_id [String] - # # @param company_name [String] - # # @param receiver_id_number [String] - # # @param receiver_name [String] - # # @param resolve_at [Time] - # # @param standard_entry_class_code [Symbol, Increase::Models::Simulations::InboundACHTransferCreateParams::StandardEntryClassCode] - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize( - # account_number_id:, - # amount:, - # company_descriptive_date: nil, - # company_discretionary_data: nil, - # company_entry_description: nil, - # company_id: nil, - # company_name: nil, - # receiver_id_number: nil, - # receiver_name: nil, - # resolve_at: nil, - # standard_entry_class_code: nil, - # request_options: {}, - # ** - # ) - # super - # end - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(account_number_id:, amount:, company_descriptive_date: nil, company_discretionary_data: nil, company_entry_description: nil, company_id: nil, company_name: nil, receiver_id_number: nil, receiver_name: nil, resolve_at: nil, standard_entry_class_code: nil, request_options: {}) + # @param account_number_id [String] + # @param amount [Integer] + # @param company_descriptive_date [String] + # @param company_discretionary_data [String] + # @param company_entry_description [String] + # @param company_id [String] + # @param company_name [String] + # @param receiver_id_number [String] + # @param receiver_name [String] + # @param resolve_at [Time] + # @param standard_entry_class_code [Symbol, Increase::Models::Simulations::InboundACHTransferCreateParams::StandardEntryClassCode] + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] # The standard entry class code for the transfer. module StandardEntryClassCode @@ -201,11 +144,8 @@ module StandardEntryClassCode # International ACH Transaction (IAT). INTERNATIONAL_ACH_TRANSACTION = :international_ach_transaction - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end diff --git a/lib/increase/models/simulations/inbound_check_deposit_create_params.rb b/lib/increase/models/simulations/inbound_check_deposit_create_params.rb index ca0d07ab6..dae81bf2b 100644 --- a/lib/increase/models/simulations/inbound_check_deposit_create_params.rb +++ b/lib/increase/models/simulations/inbound_check_deposit_create_params.rb @@ -5,8 +5,7 @@ module Models module Simulations # @see Increase::Resources::Simulations::InboundCheckDeposits#create class InboundCheckDepositCreateParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters # @!attribute account_number_id @@ -27,15 +26,11 @@ class InboundCheckDepositCreateParams < Increase::Internal::Type::BaseModel # @return [String] required :check_number, String - # @!parse - # # @param account_number_id [String] - # # @param amount [Integer] - # # @param check_number [String] - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(account_number_id:, amount:, check_number:, request_options: {}, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(account_number_id:, amount:, check_number:, request_options: {}) + # @param account_number_id [String] + # @param amount [Integer] + # @param check_number [String] + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/increase/models/simulations/inbound_funds_hold_release_params.rb b/lib/increase/models/simulations/inbound_funds_hold_release_params.rb index 48dee960b..d8dea1871 100644 --- a/lib/increase/models/simulations/inbound_funds_hold_release_params.rb +++ b/lib/increase/models/simulations/inbound_funds_hold_release_params.rb @@ -5,16 +5,11 @@ module Models module Simulations # @see Increase::Resources::Simulations::InboundFundsHolds#release class InboundFundsHoldReleaseParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters - # @!parse - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(request_options: {}, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(request_options: {}) + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/increase/models/simulations/inbound_funds_hold_release_response.rb b/lib/increase/models/simulations/inbound_funds_hold_release_response.rb index 5e7e67689..8c47dc743 100644 --- a/lib/increase/models/simulations/inbound_funds_hold_release_response.rb +++ b/lib/increase/models/simulations/inbound_funds_hold_release_response.rb @@ -70,38 +70,20 @@ class InboundFundsHoldReleaseResponse < Increase::Internal::Type::BaseModel # @return [Symbol, Increase::Models::Simulations::InboundFundsHoldReleaseResponse::Type] required :type, enum: -> { Increase::Models::Simulations::InboundFundsHoldReleaseResponse::Type } - # @!parse - # # We hold funds for certain transaction types to account for return windows where - # # funds might still be clawed back by the sending institution. - # # - # # @param id [String] - # # @param amount [Integer] - # # @param automatically_releases_at [Time] - # # @param created_at [Time] - # # @param currency [Symbol, Increase::Models::Simulations::InboundFundsHoldReleaseResponse::Currency] - # # @param held_transaction_id [String, nil] - # # @param pending_transaction_id [String, nil] - # # @param released_at [Time, nil] - # # @param status [Symbol, Increase::Models::Simulations::InboundFundsHoldReleaseResponse::Status] - # # @param type [Symbol, Increase::Models::Simulations::InboundFundsHoldReleaseResponse::Type] - # # - # def initialize( - # id:, - # amount:, - # automatically_releases_at:, - # created_at:, - # currency:, - # held_transaction_id:, - # pending_transaction_id:, - # released_at:, - # status:, - # type:, - # ** - # ) - # super - # end - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(id:, amount:, automatically_releases_at:, created_at:, currency:, held_transaction_id:, pending_transaction_id:, released_at:, status:, type:) + # We hold funds for certain transaction types to account for return windows where + # funds might still be clawed back by the sending institution. + # + # @param id [String] + # @param amount [Integer] + # @param automatically_releases_at [Time] + # @param created_at [Time] + # @param currency [Symbol, Increase::Models::Simulations::InboundFundsHoldReleaseResponse::Currency] + # @param held_transaction_id [String, nil] + # @param pending_transaction_id [String, nil] + # @param released_at [Time, nil] + # @param status [Symbol, Increase::Models::Simulations::InboundFundsHoldReleaseResponse::Status] + # @param type [Symbol, Increase::Models::Simulations::InboundFundsHoldReleaseResponse::Type] # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the hold's # currency. @@ -128,11 +110,8 @@ module Currency # US Dollar (USD) USD = :USD - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # The status of the hold. @@ -147,11 +126,8 @@ module Status # Funds have been released. COMPLETE = :complete - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # A constant representing the object's type. For this resource it will always be @@ -163,11 +139,8 @@ module Type INBOUND_FUNDS_HOLD = :inbound_funds_hold - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end diff --git a/lib/increase/models/simulations/inbound_mail_item_create_params.rb b/lib/increase/models/simulations/inbound_mail_item_create_params.rb index d38e2b91f..1a920a9ce 100644 --- a/lib/increase/models/simulations/inbound_mail_item_create_params.rb +++ b/lib/increase/models/simulations/inbound_mail_item_create_params.rb @@ -5,8 +5,7 @@ module Models module Simulations # @see Increase::Resources::Simulations::InboundMailItems#create class InboundMailItemCreateParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters # @!attribute amount @@ -21,26 +20,18 @@ class InboundMailItemCreateParams < Increase::Internal::Type::BaseModel # @return [String] required :lockbox_id, String - # @!attribute [r] contents_file_id + # @!attribute contents_file_id # The file containing the PDF contents. If not present, a default check image file # will be used. # # @return [String, nil] optional :contents_file_id, String - # @!parse - # # @return [String] - # attr_writer :contents_file_id - - # @!parse - # # @param amount [Integer] - # # @param lockbox_id [String] - # # @param contents_file_id [String] - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(amount:, lockbox_id:, contents_file_id: nil, request_options: {}, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(amount:, lockbox_id:, contents_file_id: nil, request_options: {}) + # @param amount [Integer] + # @param lockbox_id [String] + # @param contents_file_id [String] + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/increase/models/simulations/inbound_real_time_payments_transfer_create_params.rb b/lib/increase/models/simulations/inbound_real_time_payments_transfer_create_params.rb index ad13e929c..2e93db7dd 100644 --- a/lib/increase/models/simulations/inbound_real_time_payments_transfer_create_params.rb +++ b/lib/increase/models/simulations/inbound_real_time_payments_transfer_create_params.rb @@ -5,8 +5,7 @@ module Models module Simulations # @see Increase::Resources::Simulations::InboundRealTimePaymentsTransfers#create class InboundRealTimePaymentsTransferCreateParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters # @!attribute account_number_id @@ -22,81 +21,45 @@ class InboundRealTimePaymentsTransferCreateParams < Increase::Internal::Type::Ba # @return [Integer] required :amount, Integer - # @!attribute [r] debtor_account_number + # @!attribute debtor_account_number # The account number of the account that sent the transfer. # # @return [String, nil] optional :debtor_account_number, String - # @!parse - # # @return [String] - # attr_writer :debtor_account_number - - # @!attribute [r] debtor_name + # @!attribute debtor_name # The name provided by the sender of the transfer. # # @return [String, nil] optional :debtor_name, String - # @!parse - # # @return [String] - # attr_writer :debtor_name - - # @!attribute [r] debtor_routing_number + # @!attribute debtor_routing_number # The routing number of the account that sent the transfer. # # @return [String, nil] optional :debtor_routing_number, String - # @!parse - # # @return [String] - # attr_writer :debtor_routing_number - - # @!attribute [r] remittance_information + # @!attribute remittance_information # Additional information included with the transfer. # # @return [String, nil] optional :remittance_information, String - # @!parse - # # @return [String] - # attr_writer :remittance_information - - # @!attribute [r] request_for_payment_id + # @!attribute request_for_payment_id # The identifier of a pending Request for Payment that this transfer will fulfill. # # @return [String, nil] optional :request_for_payment_id, String - # @!parse - # # @return [String] - # attr_writer :request_for_payment_id - - # @!parse - # # @param account_number_id [String] - # # @param amount [Integer] - # # @param debtor_account_number [String] - # # @param debtor_name [String] - # # @param debtor_routing_number [String] - # # @param remittance_information [String] - # # @param request_for_payment_id [String] - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize( - # account_number_id:, - # amount:, - # debtor_account_number: nil, - # debtor_name: nil, - # debtor_routing_number: nil, - # remittance_information: nil, - # request_for_payment_id: nil, - # request_options: {}, - # ** - # ) - # super - # end - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(account_number_id:, amount:, debtor_account_number: nil, debtor_name: nil, debtor_routing_number: nil, remittance_information: nil, request_for_payment_id: nil, request_options: {}) + # @param account_number_id [String] + # @param amount [Integer] + # @param debtor_account_number [String] + # @param debtor_name [String] + # @param debtor_routing_number [String] + # @param remittance_information [String] + # @param request_for_payment_id [String] + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/increase/models/simulations/inbound_wire_drawdown_request_create_params.rb b/lib/increase/models/simulations/inbound_wire_drawdown_request_create_params.rb index 4e0d5d5d0..8c10a8548 100644 --- a/lib/increase/models/simulations/inbound_wire_drawdown_request_create_params.rb +++ b/lib/increase/models/simulations/inbound_wire_drawdown_request_create_params.rb @@ -5,8 +5,7 @@ module Models module Simulations # @see Increase::Resources::Simulations::InboundWireDrawdownRequests#create class InboundWireDrawdownRequestCreateParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters # @!attribute amount @@ -59,181 +58,104 @@ class InboundWireDrawdownRequestCreateParams < Increase::Internal::Type::BaseMod # @return [String] required :recipient_account_number_id, String - # @!attribute [r] beneficiary_address_line1 + # @!attribute beneficiary_address_line1 # Line 1 of the drawdown request's beneficiary's address. # # @return [String, nil] optional :beneficiary_address_line1, String - # @!parse - # # @return [String] - # attr_writer :beneficiary_address_line1 - - # @!attribute [r] beneficiary_address_line2 + # @!attribute beneficiary_address_line2 # Line 2 of the drawdown request's beneficiary's address. # # @return [String, nil] optional :beneficiary_address_line2, String - # @!parse - # # @return [String] - # attr_writer :beneficiary_address_line2 - - # @!attribute [r] beneficiary_address_line3 + # @!attribute beneficiary_address_line3 # Line 3 of the drawdown request's beneficiary's address. # # @return [String, nil] optional :beneficiary_address_line3, String - # @!parse - # # @return [String] - # attr_writer :beneficiary_address_line3 - - # @!attribute [r] beneficiary_name + # @!attribute beneficiary_name # The drawdown request's beneficiary's name. # # @return [String, nil] optional :beneficiary_name, String - # @!parse - # # @return [String] - # attr_writer :beneficiary_name - - # @!attribute [r] originator_address_line1 + # @!attribute originator_address_line1 # Line 1 of the drawdown request's originator's address. # # @return [String, nil] optional :originator_address_line1, String - # @!parse - # # @return [String] - # attr_writer :originator_address_line1 - - # @!attribute [r] originator_address_line2 + # @!attribute originator_address_line2 # Line 2 of the drawdown request's originator's address. # # @return [String, nil] optional :originator_address_line2, String - # @!parse - # # @return [String] - # attr_writer :originator_address_line2 - - # @!attribute [r] originator_address_line3 + # @!attribute originator_address_line3 # Line 3 of the drawdown request's originator's address. # # @return [String, nil] optional :originator_address_line3, String - # @!parse - # # @return [String] - # attr_writer :originator_address_line3 - - # @!attribute [r] originator_name + # @!attribute originator_name # The drawdown request's originator's name. # # @return [String, nil] optional :originator_name, String - # @!parse - # # @return [String] - # attr_writer :originator_name - - # @!attribute [r] originator_to_beneficiary_information_line1 + # @!attribute originator_to_beneficiary_information_line1 # Line 1 of the information conveyed from the originator of the message to the # beneficiary. # # @return [String, nil] optional :originator_to_beneficiary_information_line1, String - # @!parse - # # @return [String] - # attr_writer :originator_to_beneficiary_information_line1 - - # @!attribute [r] originator_to_beneficiary_information_line2 + # @!attribute originator_to_beneficiary_information_line2 # Line 2 of the information conveyed from the originator of the message to the # beneficiary. # # @return [String, nil] optional :originator_to_beneficiary_information_line2, String - # @!parse - # # @return [String] - # attr_writer :originator_to_beneficiary_information_line2 - - # @!attribute [r] originator_to_beneficiary_information_line3 + # @!attribute originator_to_beneficiary_information_line3 # Line 3 of the information conveyed from the originator of the message to the # beneficiary. # # @return [String, nil] optional :originator_to_beneficiary_information_line3, String - # @!parse - # # @return [String] - # attr_writer :originator_to_beneficiary_information_line3 - - # @!attribute [r] originator_to_beneficiary_information_line4 + # @!attribute originator_to_beneficiary_information_line4 # Line 4 of the information conveyed from the originator of the message to the # beneficiary. # # @return [String, nil] optional :originator_to_beneficiary_information_line4, String - # @!parse - # # @return [String] - # attr_writer :originator_to_beneficiary_information_line4 - - # @!parse - # # @param amount [Integer] - # # @param beneficiary_account_number [String] - # # @param beneficiary_routing_number [String] - # # @param currency [String] - # # @param message_to_recipient [String] - # # @param originator_account_number [String] - # # @param originator_routing_number [String] - # # @param recipient_account_number_id [String] - # # @param beneficiary_address_line1 [String] - # # @param beneficiary_address_line2 [String] - # # @param beneficiary_address_line3 [String] - # # @param beneficiary_name [String] - # # @param originator_address_line1 [String] - # # @param originator_address_line2 [String] - # # @param originator_address_line3 [String] - # # @param originator_name [String] - # # @param originator_to_beneficiary_information_line1 [String] - # # @param originator_to_beneficiary_information_line2 [String] - # # @param originator_to_beneficiary_information_line3 [String] - # # @param originator_to_beneficiary_information_line4 [String] - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize( - # amount:, - # beneficiary_account_number:, - # beneficiary_routing_number:, - # currency:, - # message_to_recipient:, - # originator_account_number:, - # originator_routing_number:, - # recipient_account_number_id:, - # beneficiary_address_line1: nil, - # beneficiary_address_line2: nil, - # beneficiary_address_line3: nil, - # beneficiary_name: nil, - # originator_address_line1: nil, - # originator_address_line2: nil, - # originator_address_line3: nil, - # originator_name: nil, - # originator_to_beneficiary_information_line1: nil, - # originator_to_beneficiary_information_line2: nil, - # originator_to_beneficiary_information_line3: nil, - # originator_to_beneficiary_information_line4: nil, - # request_options: {}, - # ** - # ) - # super - # end - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(amount:, beneficiary_account_number:, beneficiary_routing_number:, currency:, message_to_recipient:, originator_account_number:, originator_routing_number:, recipient_account_number_id:, beneficiary_address_line1: nil, beneficiary_address_line2: nil, beneficiary_address_line3: nil, beneficiary_name: nil, originator_address_line1: nil, originator_address_line2: nil, originator_address_line3: nil, originator_name: nil, originator_to_beneficiary_information_line1: nil, originator_to_beneficiary_information_line2: nil, originator_to_beneficiary_information_line3: nil, originator_to_beneficiary_information_line4: nil, request_options: {}) + # @param amount [Integer] + # @param beneficiary_account_number [String] + # @param beneficiary_routing_number [String] + # @param currency [String] + # @param message_to_recipient [String] + # @param originator_account_number [String] + # @param originator_routing_number [String] + # @param recipient_account_number_id [String] + # @param beneficiary_address_line1 [String] + # @param beneficiary_address_line2 [String] + # @param beneficiary_address_line3 [String] + # @param beneficiary_name [String] + # @param originator_address_line1 [String] + # @param originator_address_line2 [String] + # @param originator_address_line3 [String] + # @param originator_name [String] + # @param originator_to_beneficiary_information_line1 [String] + # @param originator_to_beneficiary_information_line2 [String] + # @param originator_to_beneficiary_information_line3 [String] + # @param originator_to_beneficiary_information_line4 [String] + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/increase/models/simulations/inbound_wire_transfer_create_params.rb b/lib/increase/models/simulations/inbound_wire_transfer_create_params.rb index df2c1a9df..48649b919 100644 --- a/lib/increase/models/simulations/inbound_wire_transfer_create_params.rb +++ b/lib/increase/models/simulations/inbound_wire_transfer_create_params.rb @@ -5,8 +5,7 @@ module Models module Simulations # @see Increase::Resources::Simulations::InboundWireTransfers#create class InboundWireTransferCreateParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters # @!attribute account_number_id @@ -21,216 +20,130 @@ class InboundWireTransferCreateParams < Increase::Internal::Type::BaseModel # @return [Integer] required :amount, Integer - # @!attribute [r] beneficiary_address_line1 + # @!attribute beneficiary_address_line1 # The sending bank will set beneficiary_address_line1 in production. You can # simulate any value here. # # @return [String, nil] optional :beneficiary_address_line1, String - # @!parse - # # @return [String] - # attr_writer :beneficiary_address_line1 - - # @!attribute [r] beneficiary_address_line2 + # @!attribute beneficiary_address_line2 # The sending bank will set beneficiary_address_line2 in production. You can # simulate any value here. # # @return [String, nil] optional :beneficiary_address_line2, String - # @!parse - # # @return [String] - # attr_writer :beneficiary_address_line2 - - # @!attribute [r] beneficiary_address_line3 + # @!attribute beneficiary_address_line3 # The sending bank will set beneficiary_address_line3 in production. You can # simulate any value here. # # @return [String, nil] optional :beneficiary_address_line3, String - # @!parse - # # @return [String] - # attr_writer :beneficiary_address_line3 - - # @!attribute [r] beneficiary_name + # @!attribute beneficiary_name # The sending bank will set beneficiary_name in production. You can simulate any # value here. # # @return [String, nil] optional :beneficiary_name, String - # @!parse - # # @return [String] - # attr_writer :beneficiary_name - - # @!attribute [r] beneficiary_reference + # @!attribute beneficiary_reference # The sending bank will set beneficiary_reference in production. You can simulate # any value here. # # @return [String, nil] optional :beneficiary_reference, String - # @!parse - # # @return [String] - # attr_writer :beneficiary_reference - - # @!attribute [r] originator_address_line1 + # @!attribute originator_address_line1 # The sending bank will set originator_address_line1 in production. You can # simulate any value here. # # @return [String, nil] optional :originator_address_line1, String - # @!parse - # # @return [String] - # attr_writer :originator_address_line1 - - # @!attribute [r] originator_address_line2 + # @!attribute originator_address_line2 # The sending bank will set originator_address_line2 in production. You can # simulate any value here. # # @return [String, nil] optional :originator_address_line2, String - # @!parse - # # @return [String] - # attr_writer :originator_address_line2 - - # @!attribute [r] originator_address_line3 + # @!attribute originator_address_line3 # The sending bank will set originator_address_line3 in production. You can # simulate any value here. # # @return [String, nil] optional :originator_address_line3, String - # @!parse - # # @return [String] - # attr_writer :originator_address_line3 - - # @!attribute [r] originator_name + # @!attribute originator_name # The sending bank will set originator_name in production. You can simulate any # value here. # # @return [String, nil] optional :originator_name, String - # @!parse - # # @return [String] - # attr_writer :originator_name - - # @!attribute [r] originator_routing_number + # @!attribute originator_routing_number # The sending bank will set originator_routing_number in production. You can # simulate any value here. # # @return [String, nil] optional :originator_routing_number, String - # @!parse - # # @return [String] - # attr_writer :originator_routing_number - - # @!attribute [r] originator_to_beneficiary_information_line1 + # @!attribute originator_to_beneficiary_information_line1 # The sending bank will set originator_to_beneficiary_information_line1 in # production. You can simulate any value here. # # @return [String, nil] optional :originator_to_beneficiary_information_line1, String - # @!parse - # # @return [String] - # attr_writer :originator_to_beneficiary_information_line1 - - # @!attribute [r] originator_to_beneficiary_information_line2 + # @!attribute originator_to_beneficiary_information_line2 # The sending bank will set originator_to_beneficiary_information_line2 in # production. You can simulate any value here. # # @return [String, nil] optional :originator_to_beneficiary_information_line2, String - # @!parse - # # @return [String] - # attr_writer :originator_to_beneficiary_information_line2 - - # @!attribute [r] originator_to_beneficiary_information_line3 + # @!attribute originator_to_beneficiary_information_line3 # The sending bank will set originator_to_beneficiary_information_line3 in # production. You can simulate any value here. # # @return [String, nil] optional :originator_to_beneficiary_information_line3, String - # @!parse - # # @return [String] - # attr_writer :originator_to_beneficiary_information_line3 - - # @!attribute [r] originator_to_beneficiary_information_line4 + # @!attribute originator_to_beneficiary_information_line4 # The sending bank will set originator_to_beneficiary_information_line4 in # production. You can simulate any value here. # # @return [String, nil] optional :originator_to_beneficiary_information_line4, String - # @!parse - # # @return [String] - # attr_writer :originator_to_beneficiary_information_line4 - - # @!attribute [r] sender_reference + # @!attribute sender_reference # The sending bank will set sender_reference in production. You can simulate any # value here. # # @return [String, nil] optional :sender_reference, String - # @!parse - # # @return [String] - # attr_writer :sender_reference - - # @!parse - # # @param account_number_id [String] - # # @param amount [Integer] - # # @param beneficiary_address_line1 [String] - # # @param beneficiary_address_line2 [String] - # # @param beneficiary_address_line3 [String] - # # @param beneficiary_name [String] - # # @param beneficiary_reference [String] - # # @param originator_address_line1 [String] - # # @param originator_address_line2 [String] - # # @param originator_address_line3 [String] - # # @param originator_name [String] - # # @param originator_routing_number [String] - # # @param originator_to_beneficiary_information_line1 [String] - # # @param originator_to_beneficiary_information_line2 [String] - # # @param originator_to_beneficiary_information_line3 [String] - # # @param originator_to_beneficiary_information_line4 [String] - # # @param sender_reference [String] - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize( - # account_number_id:, - # amount:, - # beneficiary_address_line1: nil, - # beneficiary_address_line2: nil, - # beneficiary_address_line3: nil, - # beneficiary_name: nil, - # beneficiary_reference: nil, - # originator_address_line1: nil, - # originator_address_line2: nil, - # originator_address_line3: nil, - # originator_name: nil, - # originator_routing_number: nil, - # originator_to_beneficiary_information_line1: nil, - # originator_to_beneficiary_information_line2: nil, - # originator_to_beneficiary_information_line3: nil, - # originator_to_beneficiary_information_line4: nil, - # sender_reference: nil, - # request_options: {}, - # ** - # ) - # super - # end - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(account_number_id:, amount:, beneficiary_address_line1: nil, beneficiary_address_line2: nil, beneficiary_address_line3: nil, beneficiary_name: nil, beneficiary_reference: nil, originator_address_line1: nil, originator_address_line2: nil, originator_address_line3: nil, originator_name: nil, originator_routing_number: nil, originator_to_beneficiary_information_line1: nil, originator_to_beneficiary_information_line2: nil, originator_to_beneficiary_information_line3: nil, originator_to_beneficiary_information_line4: nil, sender_reference: nil, request_options: {}) + # @param account_number_id [String] + # @param amount [Integer] + # @param beneficiary_address_line1 [String] + # @param beneficiary_address_line2 [String] + # @param beneficiary_address_line3 [String] + # @param beneficiary_name [String] + # @param beneficiary_reference [String] + # @param originator_address_line1 [String] + # @param originator_address_line2 [String] + # @param originator_address_line3 [String] + # @param originator_name [String] + # @param originator_routing_number [String] + # @param originator_to_beneficiary_information_line1 [String] + # @param originator_to_beneficiary_information_line2 [String] + # @param originator_to_beneficiary_information_line3 [String] + # @param originator_to_beneficiary_information_line4 [String] + # @param sender_reference [String] + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/increase/models/simulations/interest_payment_create_params.rb b/lib/increase/models/simulations/interest_payment_create_params.rb index 6d9055243..5130e7f2b 100644 --- a/lib/increase/models/simulations/interest_payment_create_params.rb +++ b/lib/increase/models/simulations/interest_payment_create_params.rb @@ -5,8 +5,7 @@ module Models module Simulations # @see Increase::Resources::Simulations::InterestPayments#create class InterestPaymentCreateParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters # @!attribute account_id @@ -21,57 +20,31 @@ class InterestPaymentCreateParams < Increase::Internal::Type::BaseModel # @return [Integer] required :amount, Integer - # @!attribute [r] accrued_on_account_id + # @!attribute accrued_on_account_id # The identifier of the Account the Interest accrued on. Defaults to `account_id`. # # @return [String, nil] optional :accrued_on_account_id, String - # @!parse - # # @return [String] - # attr_writer :accrued_on_account_id - - # @!attribute [r] period_end + # @!attribute period_end # The end of the interest period. If not provided, defaults to the current time. # # @return [Time, nil] optional :period_end, Time - # @!parse - # # @return [Time] - # attr_writer :period_end - - # @!attribute [r] period_start + # @!attribute period_start # The start of the interest period. If not provided, defaults to the current time. # # @return [Time, nil] optional :period_start, Time - # @!parse - # # @return [Time] - # attr_writer :period_start - - # @!parse - # # @param account_id [String] - # # @param amount [Integer] - # # @param accrued_on_account_id [String] - # # @param period_end [Time] - # # @param period_start [Time] - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize( - # account_id:, - # amount:, - # accrued_on_account_id: nil, - # period_end: nil, - # period_start: nil, - # request_options: {}, - # ** - # ) - # super - # end - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(account_id:, amount:, accrued_on_account_id: nil, period_end: nil, period_start: nil, request_options: {}) + # @param account_id [String] + # @param amount [Integer] + # @param accrued_on_account_id [String] + # @param period_end [Time] + # @param period_start [Time] + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/increase/models/simulations/physical_card_advance_shipment_params.rb b/lib/increase/models/simulations/physical_card_advance_shipment_params.rb index e4649fa0d..a9ae77352 100644 --- a/lib/increase/models/simulations/physical_card_advance_shipment_params.rb +++ b/lib/increase/models/simulations/physical_card_advance_shipment_params.rb @@ -5,8 +5,7 @@ module Models module Simulations # @see Increase::Resources::Simulations::PhysicalCards#advance_shipment class PhysicalCardAdvanceShipmentParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters # @!attribute shipment_status @@ -16,13 +15,9 @@ class PhysicalCardAdvanceShipmentParams < Increase::Internal::Type::BaseModel required :shipment_status, enum: -> { Increase::Models::Simulations::PhysicalCardAdvanceShipmentParams::ShipmentStatus } - # @!parse - # # @param shipment_status [Symbol, Increase::Models::Simulations::PhysicalCardAdvanceShipmentParams::ShipmentStatus] - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(shipment_status:, request_options: {}, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(shipment_status:, request_options: {}) + # @param shipment_status [Symbol, Increase::Models::Simulations::PhysicalCardAdvanceShipmentParams::ShipmentStatus] + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] # The shipment status to move the Physical Card to. module ShipmentStatus @@ -49,11 +44,8 @@ module ShipmentStatus # The physical card shipment was returned to the sender and destroyed by the production facility. RETURNED = :returned - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end diff --git a/lib/increase/models/simulations/program_create_params.rb b/lib/increase/models/simulations/program_create_params.rb index 925f8a7c9..5ab482b36 100644 --- a/lib/increase/models/simulations/program_create_params.rb +++ b/lib/increase/models/simulations/program_create_params.rb @@ -5,8 +5,7 @@ module Models module Simulations # @see Increase::Resources::Simulations::Programs#create class ProgramCreateParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters # @!attribute name @@ -15,13 +14,9 @@ class ProgramCreateParams < Increase::Internal::Type::BaseModel # @return [String] required :name, String - # @!parse - # # @param name [String] - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(name:, request_options: {}, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(name:, request_options: {}) + # @param name [String] + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/increase/models/simulations/real_time_payments_transfer_complete_params.rb b/lib/increase/models/simulations/real_time_payments_transfer_complete_params.rb index f46480908..ef245103b 100644 --- a/lib/increase/models/simulations/real_time_payments_transfer_complete_params.rb +++ b/lib/increase/models/simulations/real_time_payments_transfer_complete_params.rb @@ -5,28 +5,19 @@ module Models module Simulations # @see Increase::Resources::Simulations::RealTimePaymentsTransfers#complete class RealTimePaymentsTransferCompleteParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters - # @!attribute [r] rejection + # @!attribute rejection # If set, the simulation will reject the transfer. # # @return [Increase::Models::Simulations::RealTimePaymentsTransferCompleteParams::Rejection, nil] optional :rejection, -> { Increase::Models::Simulations::RealTimePaymentsTransferCompleteParams::Rejection } - # @!parse - # # @return [Increase::Models::Simulations::RealTimePaymentsTransferCompleteParams::Rejection] - # attr_writer :rejection - - # @!parse - # # @param rejection [Increase::Models::Simulations::RealTimePaymentsTransferCompleteParams::Rejection] - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(rejection: nil, request_options: {}, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(rejection: nil, request_options: {}) + # @param rejection [Increase::Models::Simulations::RealTimePaymentsTransferCompleteParams::Rejection] + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] class Rejection < Increase::Internal::Type::BaseModel # @!attribute reject_reason_code @@ -36,14 +27,10 @@ class Rejection < Increase::Internal::Type::BaseModel required :reject_reason_code, enum: -> { Increase::Models::Simulations::RealTimePaymentsTransferCompleteParams::Rejection::RejectReasonCode } - # @!parse - # # If set, the simulation will reject the transfer. - # # - # # @param reject_reason_code [Symbol, Increase::Models::Simulations::RealTimePaymentsTransferCompleteParams::Rejection::RejectReasonCode] - # # - # def initialize(reject_reason_code:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(reject_reason_code:) + # If set, the simulation will reject the transfer. + # + # @param reject_reason_code [Symbol, Increase::Models::Simulations::RealTimePaymentsTransferCompleteParams::Rejection::RejectReasonCode] # The reason code that the simulated rejection will have. # @@ -114,11 +101,8 @@ module RejectReasonCode # Some other error or issue has occurred. OTHER = :other - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end diff --git a/lib/increase/models/simulations/wire_transfer_reverse_params.rb b/lib/increase/models/simulations/wire_transfer_reverse_params.rb index a0bc09a1a..f055932e1 100644 --- a/lib/increase/models/simulations/wire_transfer_reverse_params.rb +++ b/lib/increase/models/simulations/wire_transfer_reverse_params.rb @@ -5,16 +5,11 @@ module Models module Simulations # @see Increase::Resources::Simulations::WireTransfers#reverse class WireTransferReverseParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters - # @!parse - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(request_options: {}, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(request_options: {}) + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/increase/models/simulations/wire_transfer_submit_params.rb b/lib/increase/models/simulations/wire_transfer_submit_params.rb index ec1cccf16..a0fb26255 100644 --- a/lib/increase/models/simulations/wire_transfer_submit_params.rb +++ b/lib/increase/models/simulations/wire_transfer_submit_params.rb @@ -5,16 +5,11 @@ module Models module Simulations # @see Increase::Resources::Simulations::WireTransfers#submit class WireTransferSubmitParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters - # @!parse - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(request_options: {}, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(request_options: {}) + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/increase/models/supplemental_document_create_params.rb b/lib/increase/models/supplemental_document_create_params.rb index 51ef0565a..0dffdb299 100644 --- a/lib/increase/models/supplemental_document_create_params.rb +++ b/lib/increase/models/supplemental_document_create_params.rb @@ -4,8 +4,7 @@ module Increase module Models # @see Increase::Resources::SupplementalDocuments#create class SupplementalDocumentCreateParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters # @!attribute entity_id @@ -20,14 +19,10 @@ class SupplementalDocumentCreateParams < Increase::Internal::Type::BaseModel # @return [String] required :file_id, String - # @!parse - # # @param entity_id [String] - # # @param file_id [String] - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(entity_id:, file_id:, request_options: {}, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(entity_id:, file_id:, request_options: {}) + # @param entity_id [String] + # @param file_id [String] + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/increase/models/supplemental_document_list_params.rb b/lib/increase/models/supplemental_document_list_params.rb index 5af811797..46888eec1 100644 --- a/lib/increase/models/supplemental_document_list_params.rb +++ b/lib/increase/models/supplemental_document_list_params.rb @@ -4,8 +4,7 @@ module Increase module Models # @see Increase::Resources::SupplementalDocuments#list class SupplementalDocumentListParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters # @!attribute entity_id @@ -14,17 +13,13 @@ class SupplementalDocumentListParams < Increase::Internal::Type::BaseModel # @return [String] required :entity_id, String - # @!attribute [r] cursor + # @!attribute cursor # Return the page of entries after this one. # # @return [String, nil] optional :cursor, String - # @!parse - # # @return [String] - # attr_writer :cursor - - # @!attribute [r] idempotency_key + # @!attribute idempotency_key # Filter records to the one with the specified `idempotency_key` you chose for # that object. This value is unique across Increase and is used to ensure that a # request is only processed once. Learn more about @@ -33,31 +28,19 @@ class SupplementalDocumentListParams < Increase::Internal::Type::BaseModel # @return [String, nil] optional :idempotency_key, String - # @!parse - # # @return [String] - # attr_writer :idempotency_key - - # @!attribute [r] limit + # @!attribute limit # Limit the size of the list that is returned. The default (and maximum) is 100 # objects. # # @return [Integer, nil] optional :limit, Integer - # @!parse - # # @return [Integer] - # attr_writer :limit - - # @!parse - # # @param entity_id [String] - # # @param cursor [String] - # # @param idempotency_key [String] - # # @param limit [Integer] - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(entity_id:, cursor: nil, idempotency_key: nil, limit: nil, request_options: {}, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(entity_id:, cursor: nil, idempotency_key: nil, limit: nil, request_options: {}) + # @param entity_id [String] + # @param cursor [String] + # @param idempotency_key [String] + # @param limit [Integer] + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/increase/models/transaction.rb b/lib/increase/models/transaction.rb index 49e34936e..9752bb319 100644 --- a/lib/increase/models/transaction.rb +++ b/lib/increase/models/transaction.rb @@ -75,38 +75,20 @@ class Transaction < Increase::Internal::Type::BaseModel # @return [Symbol, Increase::Models::Transaction::Type] required :type, enum: -> { Increase::Models::Transaction::Type } - # @!parse - # # Transactions are the immutable additions and removals of money from your bank - # # account. They're the equivalent of line items on your bank statement. - # # - # # @param id [String] - # # @param account_id [String] - # # @param amount [Integer] - # # @param created_at [Time] - # # @param currency [Symbol, Increase::Models::Transaction::Currency] - # # @param description [String] - # # @param route_id [String, nil] - # # @param route_type [Symbol, Increase::Models::Transaction::RouteType, nil] - # # @param source [Increase::Models::Transaction::Source] - # # @param type [Symbol, Increase::Models::Transaction::Type] - # # - # def initialize( - # id:, - # account_id:, - # amount:, - # created_at:, - # currency:, - # description:, - # route_id:, - # route_type:, - # source:, - # type:, - # ** - # ) - # super - # end - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(id:, account_id:, amount:, created_at:, currency:, description:, route_id:, route_type:, source:, type:) + # Transactions are the immutable additions and removals of money from your bank + # account. They're the equivalent of line items on your bank statement. + # + # @param id [String] + # @param account_id [String] + # @param amount [Integer] + # @param created_at [Time] + # @param currency [Symbol, Increase::Models::Transaction::Currency] + # @param description [String] + # @param route_id [String, nil] + # @param route_type [Symbol, Increase::Models::Transaction::RouteType, nil] + # @param source [Increase::Models::Transaction::Source] + # @param type [Symbol, Increase::Models::Transaction::Type] # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the # Transaction's currency. This will match the currency on the Transaction's @@ -134,11 +116,8 @@ module Currency # US Dollar (USD) USD = :USD - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # The type of the route this Transaction came through. @@ -156,11 +135,8 @@ module RouteType # A Lockbox. LOCKBOX = :lockbox - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Increase::Models::Transaction#source @@ -474,80 +450,42 @@ class Source < Increase::Internal::Type::BaseModel -> { Increase::Models::Transaction::Source::WireTransferIntention }, nil?: true - # @!parse - # # This is an object giving more details on the network-level event that caused the - # # Transaction. Note that for backwards compatibility reasons, additional - # # undocumented keys may appear in this object. These should be treated as - # # deprecated and will be removed in the future. - # # - # # @param account_transfer_intention [Increase::Models::Transaction::Source::AccountTransferIntention, nil] - # # @param ach_transfer_intention [Increase::Models::Transaction::Source::ACHTransferIntention, nil] - # # @param ach_transfer_rejection [Increase::Models::Transaction::Source::ACHTransferRejection, nil] - # # @param ach_transfer_return [Increase::Models::Transaction::Source::ACHTransferReturn, nil] - # # @param card_dispute_acceptance [Increase::Models::Transaction::Source::CardDisputeAcceptance, nil] - # # @param card_dispute_loss [Increase::Models::Transaction::Source::CardDisputeLoss, nil] - # # @param card_refund [Increase::Models::Transaction::Source::CardRefund, nil] - # # @param card_revenue_payment [Increase::Models::Transaction::Source::CardRevenuePayment, nil] - # # @param card_settlement [Increase::Models::Transaction::Source::CardSettlement, nil] - # # @param cashback_payment [Increase::Models::Transaction::Source::CashbackPayment, nil] - # # @param category [Symbol, Increase::Models::Transaction::Source::Category] - # # @param check_deposit_acceptance [Increase::Models::Transaction::Source::CheckDepositAcceptance, nil] - # # @param check_deposit_return [Increase::Models::Transaction::Source::CheckDepositReturn, nil] - # # @param check_transfer_deposit [Increase::Models::Transaction::Source::CheckTransferDeposit, nil] - # # @param fee_payment [Increase::Models::Transaction::Source::FeePayment, nil] - # # @param inbound_ach_transfer [Increase::Models::Transaction::Source::InboundACHTransfer, nil] - # # @param inbound_ach_transfer_return_intention [Increase::Models::Transaction::Source::InboundACHTransferReturnIntention, nil] - # # @param inbound_check_adjustment [Increase::Models::Transaction::Source::InboundCheckAdjustment, nil] - # # @param inbound_check_deposit_return_intention [Increase::Models::Transaction::Source::InboundCheckDepositReturnIntention, nil] - # # @param inbound_real_time_payments_transfer_confirmation [Increase::Models::Transaction::Source::InboundRealTimePaymentsTransferConfirmation, nil] - # # @param inbound_real_time_payments_transfer_decline [Increase::Models::Transaction::Source::InboundRealTimePaymentsTransferDecline, nil] - # # @param inbound_wire_reversal [Increase::Models::Transaction::Source::InboundWireReversal, nil] - # # @param inbound_wire_transfer [Increase::Models::Transaction::Source::InboundWireTransfer, nil] - # # @param inbound_wire_transfer_reversal [Increase::Models::Transaction::Source::InboundWireTransferReversal, nil] - # # @param interest_payment [Increase::Models::Transaction::Source::InterestPayment, nil] - # # @param internal_source [Increase::Models::Transaction::Source::InternalSource, nil] - # # @param other [Object, nil] - # # @param real_time_payments_transfer_acknowledgement [Increase::Models::Transaction::Source::RealTimePaymentsTransferAcknowledgement, nil] - # # @param sample_funds [Increase::Models::Transaction::Source::SampleFunds, nil] - # # @param wire_transfer_intention [Increase::Models::Transaction::Source::WireTransferIntention, nil] - # # - # def initialize( - # account_transfer_intention:, - # ach_transfer_intention:, - # ach_transfer_rejection:, - # ach_transfer_return:, - # card_dispute_acceptance:, - # card_dispute_loss:, - # card_refund:, - # card_revenue_payment:, - # card_settlement:, - # cashback_payment:, - # category:, - # check_deposit_acceptance:, - # check_deposit_return:, - # check_transfer_deposit:, - # fee_payment:, - # inbound_ach_transfer:, - # inbound_ach_transfer_return_intention:, - # inbound_check_adjustment:, - # inbound_check_deposit_return_intention:, - # inbound_real_time_payments_transfer_confirmation:, - # inbound_real_time_payments_transfer_decline:, - # inbound_wire_reversal:, - # inbound_wire_transfer:, - # inbound_wire_transfer_reversal:, - # interest_payment:, - # internal_source:, - # other:, - # real_time_payments_transfer_acknowledgement:, - # sample_funds:, - # wire_transfer_intention:, - # ** - # ) - # super - # end - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(account_transfer_intention:, ach_transfer_intention:, ach_transfer_rejection:, ach_transfer_return:, card_dispute_acceptance:, card_dispute_loss:, card_refund:, card_revenue_payment:, card_settlement:, cashback_payment:, category:, check_deposit_acceptance:, check_deposit_return:, check_transfer_deposit:, fee_payment:, inbound_ach_transfer:, inbound_ach_transfer_return_intention:, inbound_check_adjustment:, inbound_check_deposit_return_intention:, inbound_real_time_payments_transfer_confirmation:, inbound_real_time_payments_transfer_decline:, inbound_wire_reversal:, inbound_wire_transfer:, inbound_wire_transfer_reversal:, interest_payment:, internal_source:, other:, real_time_payments_transfer_acknowledgement:, sample_funds:, wire_transfer_intention:) + # This is an object giving more details on the network-level event that caused the + # Transaction. Note that for backwards compatibility reasons, additional + # undocumented keys may appear in this object. These should be treated as + # deprecated and will be removed in the future. + # + # @param account_transfer_intention [Increase::Models::Transaction::Source::AccountTransferIntention, nil] + # @param ach_transfer_intention [Increase::Models::Transaction::Source::ACHTransferIntention, nil] + # @param ach_transfer_rejection [Increase::Models::Transaction::Source::ACHTransferRejection, nil] + # @param ach_transfer_return [Increase::Models::Transaction::Source::ACHTransferReturn, nil] + # @param card_dispute_acceptance [Increase::Models::Transaction::Source::CardDisputeAcceptance, nil] + # @param card_dispute_loss [Increase::Models::Transaction::Source::CardDisputeLoss, nil] + # @param card_refund [Increase::Models::Transaction::Source::CardRefund, nil] + # @param card_revenue_payment [Increase::Models::Transaction::Source::CardRevenuePayment, nil] + # @param card_settlement [Increase::Models::Transaction::Source::CardSettlement, nil] + # @param cashback_payment [Increase::Models::Transaction::Source::CashbackPayment, nil] + # @param category [Symbol, Increase::Models::Transaction::Source::Category] + # @param check_deposit_acceptance [Increase::Models::Transaction::Source::CheckDepositAcceptance, nil] + # @param check_deposit_return [Increase::Models::Transaction::Source::CheckDepositReturn, nil] + # @param check_transfer_deposit [Increase::Models::Transaction::Source::CheckTransferDeposit, nil] + # @param fee_payment [Increase::Models::Transaction::Source::FeePayment, nil] + # @param inbound_ach_transfer [Increase::Models::Transaction::Source::InboundACHTransfer, nil] + # @param inbound_ach_transfer_return_intention [Increase::Models::Transaction::Source::InboundACHTransferReturnIntention, nil] + # @param inbound_check_adjustment [Increase::Models::Transaction::Source::InboundCheckAdjustment, nil] + # @param inbound_check_deposit_return_intention [Increase::Models::Transaction::Source::InboundCheckDepositReturnIntention, nil] + # @param inbound_real_time_payments_transfer_confirmation [Increase::Models::Transaction::Source::InboundRealTimePaymentsTransferConfirmation, nil] + # @param inbound_real_time_payments_transfer_decline [Increase::Models::Transaction::Source::InboundRealTimePaymentsTransferDecline, nil] + # @param inbound_wire_reversal [Increase::Models::Transaction::Source::InboundWireReversal, nil] + # @param inbound_wire_transfer [Increase::Models::Transaction::Source::InboundWireTransfer, nil] + # @param inbound_wire_transfer_reversal [Increase::Models::Transaction::Source::InboundWireTransferReversal, nil] + # @param interest_payment [Increase::Models::Transaction::Source::InterestPayment, nil] + # @param internal_source [Increase::Models::Transaction::Source::InternalSource, nil] + # @param other [Object, nil] + # @param real_time_payments_transfer_acknowledgement [Increase::Models::Transaction::Source::RealTimePaymentsTransferAcknowledgement, nil] + # @param sample_funds [Increase::Models::Transaction::Source::SampleFunds, nil] + # @param wire_transfer_intention [Increase::Models::Transaction::Source::WireTransferIntention, nil] # @see Increase::Models::Transaction::Source#account_transfer_intention class AccountTransferIntention < Increase::Internal::Type::BaseModel @@ -589,22 +527,18 @@ class AccountTransferIntention < Increase::Internal::Type::BaseModel # @return [String] required :transfer_id, String - # @!parse - # # An Account Transfer Intention object. This field will be present in the JSON - # # response if and only if `category` is equal to `account_transfer_intention`. Two - # # Account Transfer Intentions are created from each Account Transfer. One - # # decrements the source account, and the other increments the destination account. - # # - # # @param amount [Integer] - # # @param currency [Symbol, Increase::Models::Transaction::Source::AccountTransferIntention::Currency] - # # @param description [String] - # # @param destination_account_id [String] - # # @param source_account_id [String] - # # @param transfer_id [String] - # # - # def initialize(amount:, currency:, description:, destination_account_id:, source_account_id:, transfer_id:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(amount:, currency:, description:, destination_account_id:, source_account_id:, transfer_id:) + # An Account Transfer Intention object. This field will be present in the JSON + # response if and only if `category` is equal to `account_transfer_intention`. Two + # Account Transfer Intentions are created from each Account Transfer. One + # decrements the source account, and the other increments the destination account. + # + # @param amount [Integer] + # @param currency [Symbol, Increase::Models::Transaction::Source::AccountTransferIntention::Currency] + # @param description [String] + # @param destination_account_id [String] + # @param source_account_id [String] + # @param transfer_id [String] # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the destination # account currency. @@ -631,11 +565,8 @@ module Currency # US Dollar (USD) USD = :USD - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -673,21 +604,17 @@ class ACHTransferIntention < Increase::Internal::Type::BaseModel # @return [String] required :transfer_id, String - # @!parse - # # An ACH Transfer Intention object. This field will be present in the JSON - # # response if and only if `category` is equal to `ach_transfer_intention`. An ACH - # # Transfer Intention is created from an ACH Transfer. It reflects the intention to - # # move money into or out of an Increase account via the ACH network. - # # - # # @param account_number [String] - # # @param amount [Integer] - # # @param routing_number [String] - # # @param statement_descriptor [String] - # # @param transfer_id [String] - # # - # def initialize(account_number:, amount:, routing_number:, statement_descriptor:, transfer_id:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(account_number:, amount:, routing_number:, statement_descriptor:, transfer_id:) + # An ACH Transfer Intention object. This field will be present in the JSON + # response if and only if `category` is equal to `ach_transfer_intention`. An ACH + # Transfer Intention is created from an ACH Transfer. It reflects the intention to + # move money into or out of an Increase account via the ACH network. + # + # @param account_number [String] + # @param amount [Integer] + # @param routing_number [String] + # @param statement_descriptor [String] + # @param transfer_id [String] end # @see Increase::Models::Transaction::Source#ach_transfer_rejection @@ -698,17 +625,13 @@ class ACHTransferRejection < Increase::Internal::Type::BaseModel # @return [String] required :transfer_id, String - # @!parse - # # An ACH Transfer Rejection object. This field will be present in the JSON - # # response if and only if `category` is equal to `ach_transfer_rejection`. An ACH - # # Transfer Rejection is created when an ACH Transfer is rejected by Increase. It - # # offsets the ACH Transfer Intention. These rejections are rare. - # # - # # @param transfer_id [String] - # # - # def initialize(transfer_id:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(transfer_id:) + # An ACH Transfer Rejection object. This field will be present in the JSON + # response if and only if `category` is equal to `ach_transfer_rejection`. An ACH + # Transfer Rejection is created when an ACH Transfer is rejected by Increase. It + # offsets the ACH Transfer Intention. These rejections are rare. + # + # @param transfer_id [String] end # @see Increase::Models::Transaction::Source#ach_transfer_return @@ -755,34 +678,20 @@ class ACHTransferReturn < Increase::Internal::Type::BaseModel # @return [String] required :transfer_id, String - # @!parse - # # An ACH Transfer Return object. This field will be present in the JSON response - # # if and only if `category` is equal to `ach_transfer_return`. An ACH Transfer - # # Return is created when an ACH Transfer is returned by the receiving bank. It - # # offsets the ACH Transfer Intention. ACH Transfer Returns usually occur within - # # the first two business days after the transfer is initiated, but can occur much - # # later. - # # - # # @param created_at [Time] - # # @param raw_return_reason_code [String] - # # @param return_reason_code [Symbol, Increase::Models::Transaction::Source::ACHTransferReturn::ReturnReasonCode] - # # @param trace_number [String] - # # @param transaction_id [String] - # # @param transfer_id [String] - # # - # def initialize( - # created_at:, - # raw_return_reason_code:, - # return_reason_code:, - # trace_number:, - # transaction_id:, - # transfer_id:, - # ** - # ) - # super - # end - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(created_at:, raw_return_reason_code:, return_reason_code:, trace_number:, transaction_id:, transfer_id:) + # An ACH Transfer Return object. This field will be present in the JSON response + # if and only if `category` is equal to `ach_transfer_return`. An ACH Transfer + # Return is created when an ACH Transfer is returned by the receiving bank. It + # offsets the ACH Transfer Intention. ACH Transfer Returns usually occur within + # the first two business days after the transfer is initiated, but can occur much + # later. + # + # @param created_at [Time] + # @param raw_return_reason_code [String] + # @param return_reason_code [Symbol, Increase::Models::Transaction::Source::ACHTransferReturn::ReturnReasonCode] + # @param trace_number [String] + # @param transaction_id [String] + # @param transfer_id [String] # Why the ACH Transfer was returned. This reason code is sent by the receiving # bank back to Increase. @@ -1004,11 +913,8 @@ module ReturnReasonCode # Code R68. A rare return reason. The return was sent too late. UNTIMELY_RETURN = :untimely_return - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -1034,18 +940,14 @@ class CardDisputeAcceptance < Increase::Internal::Type::BaseModel # @return [String] required :transaction_id, String - # @!parse - # # A Card Dispute Acceptance object. This field will be present in the JSON - # # response if and only if `category` is equal to `card_dispute_acceptance`. - # # Contains the details of a successful Card Dispute. - # # - # # @param accepted_at [Time] - # # @param card_dispute_id [String] - # # @param transaction_id [String] - # # - # def initialize(accepted_at:, card_dispute_id:, transaction_id:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(accepted_at:, card_dispute_id:, transaction_id:) + # A Card Dispute Acceptance object. This field will be present in the JSON + # response if and only if `category` is equal to `card_dispute_acceptance`. + # Contains the details of a successful Card Dispute. + # + # @param accepted_at [Time] + # @param card_dispute_id [String] + # @param transaction_id [String] end # @see Increase::Models::Transaction::Source#card_dispute_loss @@ -1076,19 +978,15 @@ class CardDisputeLoss < Increase::Internal::Type::BaseModel # @return [String] required :transaction_id, String - # @!parse - # # A Card Dispute Loss object. This field will be present in the JSON response if - # # and only if `category` is equal to `card_dispute_loss`. Contains the details of - # # a lost Card Dispute. - # # - # # @param card_dispute_id [String] - # # @param explanation [String] - # # @param lost_at [Time] - # # @param transaction_id [String] - # # - # def initialize(card_dispute_id:, explanation:, lost_at:, transaction_id:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(card_dispute_id:, explanation:, lost_at:, transaction_id:) + # A Card Dispute Loss object. This field will be present in the JSON response if + # and only if `category` is equal to `card_dispute_loss`. Contains the details of + # a lost Card Dispute. + # + # @param card_dispute_id [String] + # @param explanation [String] + # @param lost_at [Time] + # @param transaction_id [String] end # @see Increase::Models::Transaction::Source#card_refund @@ -1217,59 +1115,32 @@ class CardRefund < Increase::Internal::Type::BaseModel # @return [Symbol, Increase::Models::Transaction::Source::CardRefund::Type] required :type, enum: -> { Increase::Models::Transaction::Source::CardRefund::Type } - # @!parse - # # A Card Refund object. This field will be present in the JSON response if and - # # only if `category` is equal to `card_refund`. Card Refunds move money back to - # # the cardholder. While they are usually connected to a Card Settlement an - # # acquirer can also refund money directly to a card without relation to a - # # transaction. - # # - # # @param id [String] - # # @param amount [Integer] - # # @param card_payment_id [String] - # # @param cashback [Increase::Models::Transaction::Source::CardRefund::Cashback, nil] - # # @param currency [Symbol, Increase::Models::Transaction::Source::CardRefund::Currency] - # # @param interchange [Increase::Models::Transaction::Source::CardRefund::Interchange, nil] - # # @param merchant_acceptor_id [String] - # # @param merchant_category_code [String] - # # @param merchant_city [String] - # # @param merchant_country [String] - # # @param merchant_name [String] - # # @param merchant_postal_code [String, nil] - # # @param merchant_state [String, nil] - # # @param network_identifiers [Increase::Models::Transaction::Source::CardRefund::NetworkIdentifiers] - # # @param presentment_amount [Integer] - # # @param presentment_currency [String] - # # @param purchase_details [Increase::Models::Transaction::Source::CardRefund::PurchaseDetails, nil] - # # @param transaction_id [String] - # # @param type [Symbol, Increase::Models::Transaction::Source::CardRefund::Type] - # # - # def initialize( - # id:, - # amount:, - # card_payment_id:, - # cashback:, - # currency:, - # interchange:, - # merchant_acceptor_id:, - # merchant_category_code:, - # merchant_city:, - # merchant_country:, - # merchant_name:, - # merchant_postal_code:, - # merchant_state:, - # network_identifiers:, - # presentment_amount:, - # presentment_currency:, - # purchase_details:, - # transaction_id:, - # type:, - # ** - # ) - # super - # end - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(id:, amount:, card_payment_id:, cashback:, currency:, interchange:, merchant_acceptor_id:, merchant_category_code:, merchant_city:, merchant_country:, merchant_name:, merchant_postal_code:, merchant_state:, network_identifiers:, presentment_amount:, presentment_currency:, purchase_details:, transaction_id:, type:) + # A Card Refund object. This field will be present in the JSON response if and + # only if `category` is equal to `card_refund`. Card Refunds move money back to + # the cardholder. While they are usually connected to a Card Settlement an + # acquirer can also refund money directly to a card without relation to a + # transaction. + # + # @param id [String] + # @param amount [Integer] + # @param card_payment_id [String] + # @param cashback [Increase::Models::Transaction::Source::CardRefund::Cashback, nil] + # @param currency [Symbol, Increase::Models::Transaction::Source::CardRefund::Currency] + # @param interchange [Increase::Models::Transaction::Source::CardRefund::Interchange, nil] + # @param merchant_acceptor_id [String] + # @param merchant_category_code [String] + # @param merchant_city [String] + # @param merchant_country [String] + # @param merchant_name [String] + # @param merchant_postal_code [String, nil] + # @param merchant_state [String, nil] + # @param network_identifiers [Increase::Models::Transaction::Source::CardRefund::NetworkIdentifiers] + # @param presentment_amount [Integer] + # @param presentment_currency [String] + # @param purchase_details [Increase::Models::Transaction::Source::CardRefund::PurchaseDetails, nil] + # @param transaction_id [String] + # @param type [Symbol, Increase::Models::Transaction::Source::CardRefund::Type] # @see Increase::Models::Transaction::Source::CardRefund#cashback class Cashback < Increase::Internal::Type::BaseModel @@ -1287,16 +1158,12 @@ class Cashback < Increase::Internal::Type::BaseModel # @return [Symbol, Increase::Models::Transaction::Source::CardRefund::Cashback::Currency] required :currency, enum: -> { Increase::Models::Transaction::Source::CardRefund::Cashback::Currency } - # @!parse - # # Cashback debited for this transaction, if eligible. Cashback is paid out in - # # aggregate, monthly. - # # - # # @param amount [String] - # # @param currency [Symbol, Increase::Models::Transaction::Source::CardRefund::Cashback::Currency] - # # - # def initialize(amount:, currency:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(amount:, currency:) + # Cashback debited for this transaction, if eligible. Cashback is paid out in + # aggregate, monthly. + # + # @param amount [String] + # @param currency [Symbol, Increase::Models::Transaction::Source::CardRefund::Cashback::Currency] # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the cashback. # @@ -1322,11 +1189,8 @@ module Currency # US Dollar (USD) USD = :USD - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -1355,11 +1219,8 @@ module Currency # US Dollar (USD) USD = :USD - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Increase::Models::Transaction::Source::CardRefund#interchange @@ -1386,16 +1247,12 @@ class Interchange < Increase::Internal::Type::BaseModel # @return [Symbol, Increase::Models::Transaction::Source::CardRefund::Interchange::Currency] required :currency, enum: -> { Increase::Models::Transaction::Source::CardRefund::Interchange::Currency } - # @!parse - # # Interchange assessed as a part of this transaciton. - # # - # # @param amount [String] - # # @param code [String, nil] - # # @param currency [Symbol, Increase::Models::Transaction::Source::CardRefund::Interchange::Currency] - # # - # def initialize(amount:, code:, currency:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(amount:, code:, currency:) + # Interchange assessed as a part of this transaciton. + # + # @param amount [String] + # @param code [String, nil] + # @param currency [Symbol, Increase::Models::Transaction::Source::CardRefund::Interchange::Currency] # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the interchange # reimbursement. @@ -1422,11 +1279,8 @@ module Currency # US Dollar (USD) USD = :USD - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -1452,16 +1306,12 @@ class NetworkIdentifiers < Increase::Internal::Type::BaseModel # @return [String, nil] required :transaction_id, String, nil?: true - # @!parse - # # Network-specific identifiers for this refund. - # # - # # @param acquirer_business_id [String] - # # @param acquirer_reference_number [String] - # # @param transaction_id [String, nil] - # # - # def initialize(acquirer_business_id:, acquirer_reference_number:, transaction_id:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(acquirer_business_id:, acquirer_reference_number:, transaction_id:) + # Network-specific identifiers for this refund. + # + # @param acquirer_business_id [String] + # @param acquirer_reference_number [String] + # @param transaction_id [String, nil] end # @see Increase::Models::Transaction::Source::CardRefund#purchase_details @@ -1536,38 +1386,20 @@ class PurchaseDetails < Increase::Internal::Type::BaseModel -> { Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::Travel }, nil?: true - # @!parse - # # Additional details about the card purchase, such as tax and industry-specific - # # fields. - # # - # # @param car_rental [Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::CarRental, nil] - # # @param customer_reference_identifier [String, nil] - # # @param local_tax_amount [Integer, nil] - # # @param local_tax_currency [String, nil] - # # @param lodging [Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::Lodging, nil] - # # @param national_tax_amount [Integer, nil] - # # @param national_tax_currency [String, nil] - # # @param purchase_identifier [String, nil] - # # @param purchase_identifier_format [Symbol, Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::PurchaseIdentifierFormat, nil] - # # @param travel [Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::Travel, nil] - # # - # def initialize( - # car_rental:, - # customer_reference_identifier:, - # local_tax_amount:, - # local_tax_currency:, - # lodging:, - # national_tax_amount:, - # national_tax_currency:, - # purchase_identifier:, - # purchase_identifier_format:, - # travel:, - # ** - # ) - # super - # end - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(car_rental:, customer_reference_identifier:, local_tax_amount:, local_tax_currency:, lodging:, national_tax_amount:, national_tax_currency:, purchase_identifier:, purchase_identifier_format:, travel:) + # Additional details about the card purchase, such as tax and industry-specific + # fields. + # + # @param car_rental [Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::CarRental, nil] + # @param customer_reference_identifier [String, nil] + # @param local_tax_amount [Integer, nil] + # @param local_tax_currency [String, nil] + # @param lodging [Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::Lodging, nil] + # @param national_tax_amount [Integer, nil] + # @param national_tax_currency [String, nil] + # @param purchase_identifier [String, nil] + # @param purchase_identifier_format [Symbol, Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::PurchaseIdentifierFormat, nil] + # @param travel [Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::Travel, nil] # @see Increase::Models::Transaction::Source::CardRefund::PurchaseDetails#car_rental class CarRental < Increase::Internal::Type::BaseModel @@ -1679,49 +1511,25 @@ class CarRental < Increase::Internal::Type::BaseModel # @return [String, nil] required :weekly_rental_rate_currency, String, nil?: true - # @!parse - # # Fields specific to car rentals. - # # - # # @param car_class_code [String, nil] - # # @param checkout_date [Date, nil] - # # @param daily_rental_rate_amount [Integer, nil] - # # @param daily_rental_rate_currency [String, nil] - # # @param days_rented [Integer, nil] - # # @param extra_charges [Symbol, Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::CarRental::ExtraCharges, nil] - # # @param fuel_charges_amount [Integer, nil] - # # @param fuel_charges_currency [String, nil] - # # @param insurance_charges_amount [Integer, nil] - # # @param insurance_charges_currency [String, nil] - # # @param no_show_indicator [Symbol, Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::CarRental::NoShowIndicator, nil] - # # @param one_way_drop_off_charges_amount [Integer, nil] - # # @param one_way_drop_off_charges_currency [String, nil] - # # @param renter_name [String, nil] - # # @param weekly_rental_rate_amount [Integer, nil] - # # @param weekly_rental_rate_currency [String, nil] - # # - # def initialize( - # car_class_code:, - # checkout_date:, - # daily_rental_rate_amount:, - # daily_rental_rate_currency:, - # days_rented:, - # extra_charges:, - # fuel_charges_amount:, - # fuel_charges_currency:, - # insurance_charges_amount:, - # insurance_charges_currency:, - # no_show_indicator:, - # one_way_drop_off_charges_amount:, - # one_way_drop_off_charges_currency:, - # renter_name:, - # weekly_rental_rate_amount:, - # weekly_rental_rate_currency:, - # ** - # ) - # super - # end - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(car_class_code:, checkout_date:, daily_rental_rate_amount:, daily_rental_rate_currency:, days_rented:, extra_charges:, fuel_charges_amount:, fuel_charges_currency:, insurance_charges_amount:, insurance_charges_currency:, no_show_indicator:, one_way_drop_off_charges_amount:, one_way_drop_off_charges_currency:, renter_name:, weekly_rental_rate_amount:, weekly_rental_rate_currency:) + # Fields specific to car rentals. + # + # @param car_class_code [String, nil] + # @param checkout_date [Date, nil] + # @param daily_rental_rate_amount [Integer, nil] + # @param daily_rental_rate_currency [String, nil] + # @param days_rented [Integer, nil] + # @param extra_charges [Symbol, Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::CarRental::ExtraCharges, nil] + # @param fuel_charges_amount [Integer, nil] + # @param fuel_charges_currency [String, nil] + # @param insurance_charges_amount [Integer, nil] + # @param insurance_charges_currency [String, nil] + # @param no_show_indicator [Symbol, Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::CarRental::NoShowIndicator, nil] + # @param one_way_drop_off_charges_amount [Integer, nil] + # @param one_way_drop_off_charges_currency [String, nil] + # @param renter_name [String, nil] + # @param weekly_rental_rate_amount [Integer, nil] + # @param weekly_rental_rate_currency [String, nil] # Additional charges (gas, late fee, etc.) being billed. # @@ -1747,11 +1555,8 @@ module ExtraCharges # Parking violation PARKING_VIOLATION = :parking_violation - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # An indicator that the cardholder is being billed for a reserved vehicle that was @@ -1767,11 +1572,8 @@ module NoShowIndicator # No show for specialized vehicle NO_SHOW_FOR_SPECIALIZED_VEHICLE = :no_show_for_specialized_vehicle - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -1884,49 +1686,25 @@ class Lodging < Increase::Internal::Type::BaseModel # @return [String, nil] required :total_tax_currency, String, nil?: true - # @!parse - # # Fields specific to lodging. - # # - # # @param check_in_date [Date, nil] - # # @param daily_room_rate_amount [Integer, nil] - # # @param daily_room_rate_currency [String, nil] - # # @param extra_charges [Symbol, Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::Lodging::ExtraCharges, nil] - # # @param folio_cash_advances_amount [Integer, nil] - # # @param folio_cash_advances_currency [String, nil] - # # @param food_beverage_charges_amount [Integer, nil] - # # @param food_beverage_charges_currency [String, nil] - # # @param no_show_indicator [Symbol, Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::Lodging::NoShowIndicator, nil] - # # @param prepaid_expenses_amount [Integer, nil] - # # @param prepaid_expenses_currency [String, nil] - # # @param room_nights [Integer, nil] - # # @param total_room_tax_amount [Integer, nil] - # # @param total_room_tax_currency [String, nil] - # # @param total_tax_amount [Integer, nil] - # # @param total_tax_currency [String, nil] - # # - # def initialize( - # check_in_date:, - # daily_room_rate_amount:, - # daily_room_rate_currency:, - # extra_charges:, - # folio_cash_advances_amount:, - # folio_cash_advances_currency:, - # food_beverage_charges_amount:, - # food_beverage_charges_currency:, - # no_show_indicator:, - # prepaid_expenses_amount:, - # prepaid_expenses_currency:, - # room_nights:, - # total_room_tax_amount:, - # total_room_tax_currency:, - # total_tax_amount:, - # total_tax_currency:, - # ** - # ) - # super - # end - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(check_in_date:, daily_room_rate_amount:, daily_room_rate_currency:, extra_charges:, folio_cash_advances_amount:, folio_cash_advances_currency:, food_beverage_charges_amount:, food_beverage_charges_currency:, no_show_indicator:, prepaid_expenses_amount:, prepaid_expenses_currency:, room_nights:, total_room_tax_amount:, total_room_tax_currency:, total_tax_amount:, total_tax_currency:) + # Fields specific to lodging. + # + # @param check_in_date [Date, nil] + # @param daily_room_rate_amount [Integer, nil] + # @param daily_room_rate_currency [String, nil] + # @param extra_charges [Symbol, Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::Lodging::ExtraCharges, nil] + # @param folio_cash_advances_amount [Integer, nil] + # @param folio_cash_advances_currency [String, nil] + # @param food_beverage_charges_amount [Integer, nil] + # @param food_beverage_charges_currency [String, nil] + # @param no_show_indicator [Symbol, Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::Lodging::NoShowIndicator, nil] + # @param prepaid_expenses_amount [Integer, nil] + # @param prepaid_expenses_currency [String, nil] + # @param room_nights [Integer, nil] + # @param total_room_tax_amount [Integer, nil] + # @param total_room_tax_currency [String, nil] + # @param total_tax_amount [Integer, nil] + # @param total_tax_currency [String, nil] # Additional charges (phone, late check-out, etc.) being billed. # @@ -1955,11 +1733,8 @@ module ExtraCharges # Laundry LAUNDRY = :laundry - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # Indicator that the cardholder is being billed for a reserved room that was not @@ -1975,11 +1750,8 @@ module NoShowIndicator # No show NO_SHOW = :no_show - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -2004,11 +1776,8 @@ module PurchaseIdentifierFormat # Invoice number INVOICE_NUMBER = :invoice_number - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Increase::Models::Transaction::Source::CardRefund::PurchaseDetails#travel @@ -2095,41 +1864,21 @@ class Travel < Increase::Internal::Type::BaseModel -> { Increase::Internal::Type::ArrayOf[Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::Travel::TripLeg] }, nil?: true - # @!parse - # # Fields specific to travel. - # # - # # @param ancillary [Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::Travel::Ancillary, nil] - # # @param computerized_reservation_system [String, nil] - # # @param credit_reason_indicator [Symbol, Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::Travel::CreditReasonIndicator, nil] - # # @param departure_date [Date, nil] - # # @param origination_city_airport_code [String, nil] - # # @param passenger_name [String, nil] - # # @param restricted_ticket_indicator [Symbol, Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::Travel::RestrictedTicketIndicator, nil] - # # @param ticket_change_indicator [Symbol, Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::Travel::TicketChangeIndicator, nil] - # # @param ticket_number [String, nil] - # # @param travel_agency_code [String, nil] - # # @param travel_agency_name [String, nil] - # # @param trip_legs [Array, nil] - # # - # def initialize( - # ancillary:, - # computerized_reservation_system:, - # credit_reason_indicator:, - # departure_date:, - # origination_city_airport_code:, - # passenger_name:, - # restricted_ticket_indicator:, - # ticket_change_indicator:, - # ticket_number:, - # travel_agency_code:, - # travel_agency_name:, - # trip_legs:, - # ** - # ) - # super - # end - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(ancillary:, computerized_reservation_system:, credit_reason_indicator:, departure_date:, origination_city_airport_code:, passenger_name:, restricted_ticket_indicator:, ticket_change_indicator:, ticket_number:, travel_agency_code:, travel_agency_name:, trip_legs:) + # Fields specific to travel. + # + # @param ancillary [Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::Travel::Ancillary, nil] + # @param computerized_reservation_system [String, nil] + # @param credit_reason_indicator [Symbol, Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::Travel::CreditReasonIndicator, nil] + # @param departure_date [Date, nil] + # @param origination_city_airport_code [String, nil] + # @param passenger_name [String, nil] + # @param restricted_ticket_indicator [Symbol, Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::Travel::RestrictedTicketIndicator, nil] + # @param ticket_change_indicator [Symbol, Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::Travel::TicketChangeIndicator, nil] + # @param ticket_number [String, nil] + # @param travel_agency_code [String, nil] + # @param travel_agency_name [String, nil] + # @param trip_legs [Array, nil] # @see Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::Travel#ancillary class Ancillary < Increase::Internal::Type::BaseModel @@ -2168,27 +1917,14 @@ class Ancillary < Increase::Internal::Type::BaseModel # @return [String, nil] required :ticket_document_number, String, nil?: true - # @!parse - # # Ancillary purchases in addition to the airfare. - # # - # # @param connected_ticket_document_number [String, nil] - # # @param credit_reason_indicator [Symbol, Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::Travel::Ancillary::CreditReasonIndicator, nil] - # # @param passenger_name_or_description [String, nil] - # # @param services [Array] - # # @param ticket_document_number [String, nil] - # # - # def initialize( - # connected_ticket_document_number:, - # credit_reason_indicator:, - # passenger_name_or_description:, - # services:, - # ticket_document_number:, - # ** - # ) - # super - # end - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(connected_ticket_document_number:, credit_reason_indicator:, passenger_name_or_description:, services:, ticket_document_number:) + # Ancillary purchases in addition to the airfare. + # + # @param connected_ticket_document_number [String, nil] + # @param credit_reason_indicator [Symbol, Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::Travel::Ancillary::CreditReasonIndicator, nil] + # @param passenger_name_or_description [String, nil] + # @param services [Array] + # @param ticket_document_number [String, nil] # Indicates the reason for a credit to the cardholder. # @@ -2210,11 +1946,8 @@ module CreditReasonIndicator # Other OTHER = :other - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end class Service < Increase::Internal::Type::BaseModel @@ -2232,13 +1965,9 @@ class Service < Increase::Internal::Type::BaseModel # @return [String, nil] required :sub_category, String, nil?: true - # @!parse - # # @param category [Symbol, Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::Travel::Ancillary::Service::Category, nil] - # # @param sub_category [String, nil] - # # - # def initialize(category:, sub_category:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(category:, sub_category:) + # @param category [Symbol, Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::Travel::Ancillary::Service::Category, nil] + # @param sub_category [String, nil] # Category of the ancillary service. # @@ -2318,11 +2047,8 @@ module Category # Wi-fi WIFI = :wifi - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -2353,11 +2079,8 @@ module CreditReasonIndicator # Partial refund of airline ticket PARTIAL_REFUND_OF_AIRLINE_TICKET = :partial_refund_of_airline_ticket - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # Indicates whether this ticket is non-refundable. @@ -2372,11 +2095,8 @@ module RestrictedTicketIndicator # Restricted non-refundable ticket RESTRICTED_NON_REFUNDABLE_TICKET = :restricted_non_refundable_ticket - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # Indicates why a ticket was changed. @@ -2394,11 +2114,8 @@ module TicketChangeIndicator # New ticket NEW_TICKET = :new_ticket - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end class TripLeg < Increase::Internal::Type::BaseModel @@ -2440,27 +2157,13 @@ class TripLeg < Increase::Internal::Type::BaseModel enum: -> { Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::Travel::TripLeg::StopOverCode }, nil?: true - # @!parse - # # @param carrier_code [String, nil] - # # @param destination_city_airport_code [String, nil] - # # @param fare_basis_code [String, nil] - # # @param flight_number [String, nil] - # # @param service_class [String, nil] - # # @param stop_over_code [Symbol, Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::Travel::TripLeg::StopOverCode, nil] - # # - # def initialize( - # carrier_code:, - # destination_city_airport_code:, - # fare_basis_code:, - # flight_number:, - # service_class:, - # stop_over_code:, - # ** - # ) - # super - # end - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(carrier_code:, destination_city_airport_code:, fare_basis_code:, flight_number:, service_class:, stop_over_code:) + # @param carrier_code [String, nil] + # @param destination_city_airport_code [String, nil] + # @param fare_basis_code [String, nil] + # @param flight_number [String, nil] + # @param service_class [String, nil] + # @param stop_over_code [Symbol, Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::Travel::TripLeg::StopOverCode, nil] # Indicates whether a stopover is allowed on this ticket. # @@ -2477,11 +2180,8 @@ module StopOverCode # Stop over not allowed STOP_OVER_NOT_ALLOWED = :stop_over_not_allowed - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -2496,11 +2196,8 @@ module Type CARD_REFUND = :card_refund - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -2538,20 +2235,16 @@ class CardRevenuePayment < Increase::Internal::Type::BaseModel # @return [String, nil] required :transacted_on_account_id, String, nil?: true - # @!parse - # # A Card Revenue Payment object. This field will be present in the JSON response - # # if and only if `category` is equal to `card_revenue_payment`. Card Revenue - # # Payments reflect earnings from fees on card transactions. - # # - # # @param amount [Integer] - # # @param currency [Symbol, Increase::Models::Transaction::Source::CardRevenuePayment::Currency] - # # @param period_end [Time] - # # @param period_start [Time] - # # @param transacted_on_account_id [String, nil] - # # - # def initialize(amount:, currency:, period_end:, period_start:, transacted_on_account_id:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(amount:, currency:, period_end:, period_start:, transacted_on_account_id:) + # A Card Revenue Payment object. This field will be present in the JSON response + # if and only if `category` is equal to `card_revenue_payment`. Card Revenue + # Payments reflect earnings from fees on card transactions. + # + # @param amount [Integer] + # @param currency [Symbol, Increase::Models::Transaction::Source::CardRevenuePayment::Currency] + # @param period_end [Time] + # @param period_start [Time] + # @param transacted_on_account_id [String, nil] # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction # currency. @@ -2578,11 +2271,8 @@ module Currency # US Dollar (USD) USD = :USD - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -2727,63 +2417,34 @@ class CardSettlement < Increase::Internal::Type::BaseModel # @return [Symbol, Increase::Models::Transaction::Source::CardSettlement::Type] required :type, enum: -> { Increase::Models::Transaction::Source::CardSettlement::Type } - # @!parse - # # A Card Settlement object. This field will be present in the JSON response if and - # # only if `category` is equal to `card_settlement`. Card Settlements are card - # # transactions that have cleared and settled. While a settlement is usually - # # preceded by an authorization, an acquirer can also directly clear a transaction - # # without first authorizing it. - # # - # # @param id [String] - # # @param amount [Integer] - # # @param card_authorization [String, nil] - # # @param card_payment_id [String] - # # @param cashback [Increase::Models::Transaction::Source::CardSettlement::Cashback, nil] - # # @param currency [Symbol, Increase::Models::Transaction::Source::CardSettlement::Currency] - # # @param interchange [Increase::Models::Transaction::Source::CardSettlement::Interchange, nil] - # # @param merchant_acceptor_id [String] - # # @param merchant_category_code [String] - # # @param merchant_city [String] - # # @param merchant_country [String] - # # @param merchant_name [String] - # # @param merchant_postal_code [String, nil] - # # @param merchant_state [String, nil] - # # @param network_identifiers [Increase::Models::Transaction::Source::CardSettlement::NetworkIdentifiers] - # # @param pending_transaction_id [String, nil] - # # @param presentment_amount [Integer] - # # @param presentment_currency [String] - # # @param purchase_details [Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails, nil] - # # @param transaction_id [String] - # # @param type [Symbol, Increase::Models::Transaction::Source::CardSettlement::Type] - # # - # def initialize( - # id:, - # amount:, - # card_authorization:, - # card_payment_id:, - # cashback:, - # currency:, - # interchange:, - # merchant_acceptor_id:, - # merchant_category_code:, - # merchant_city:, - # merchant_country:, - # merchant_name:, - # merchant_postal_code:, - # merchant_state:, - # network_identifiers:, - # pending_transaction_id:, - # presentment_amount:, - # presentment_currency:, - # purchase_details:, - # transaction_id:, - # type:, - # ** - # ) - # super - # end - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(id:, amount:, card_authorization:, card_payment_id:, cashback:, currency:, interchange:, merchant_acceptor_id:, merchant_category_code:, merchant_city:, merchant_country:, merchant_name:, merchant_postal_code:, merchant_state:, network_identifiers:, pending_transaction_id:, presentment_amount:, presentment_currency:, purchase_details:, transaction_id:, type:) + # A Card Settlement object. This field will be present in the JSON response if and + # only if `category` is equal to `card_settlement`. Card Settlements are card + # transactions that have cleared and settled. While a settlement is usually + # preceded by an authorization, an acquirer can also directly clear a transaction + # without first authorizing it. + # + # @param id [String] + # @param amount [Integer] + # @param card_authorization [String, nil] + # @param card_payment_id [String] + # @param cashback [Increase::Models::Transaction::Source::CardSettlement::Cashback, nil] + # @param currency [Symbol, Increase::Models::Transaction::Source::CardSettlement::Currency] + # @param interchange [Increase::Models::Transaction::Source::CardSettlement::Interchange, nil] + # @param merchant_acceptor_id [String] + # @param merchant_category_code [String] + # @param merchant_city [String] + # @param merchant_country [String] + # @param merchant_name [String] + # @param merchant_postal_code [String, nil] + # @param merchant_state [String, nil] + # @param network_identifiers [Increase::Models::Transaction::Source::CardSettlement::NetworkIdentifiers] + # @param pending_transaction_id [String, nil] + # @param presentment_amount [Integer] + # @param presentment_currency [String] + # @param purchase_details [Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails, nil] + # @param transaction_id [String] + # @param type [Symbol, Increase::Models::Transaction::Source::CardSettlement::Type] # @see Increase::Models::Transaction::Source::CardSettlement#cashback class Cashback < Increase::Internal::Type::BaseModel @@ -2801,16 +2462,12 @@ class Cashback < Increase::Internal::Type::BaseModel # @return [Symbol, Increase::Models::Transaction::Source::CardSettlement::Cashback::Currency] required :currency, enum: -> { Increase::Models::Transaction::Source::CardSettlement::Cashback::Currency } - # @!parse - # # Cashback earned on this transaction, if eligible. Cashback is paid out in - # # aggregate, monthly. - # # - # # @param amount [String] - # # @param currency [Symbol, Increase::Models::Transaction::Source::CardSettlement::Cashback::Currency] - # # - # def initialize(amount:, currency:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(amount:, currency:) + # Cashback earned on this transaction, if eligible. Cashback is paid out in + # aggregate, monthly. + # + # @param amount [String] + # @param currency [Symbol, Increase::Models::Transaction::Source::CardSettlement::Cashback::Currency] # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the cashback. # @@ -2836,11 +2493,8 @@ module Currency # US Dollar (USD) USD = :USD - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -2869,11 +2523,8 @@ module Currency # US Dollar (USD) USD = :USD - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Increase::Models::Transaction::Source::CardSettlement#interchange @@ -2901,16 +2552,12 @@ class Interchange < Increase::Internal::Type::BaseModel required :currency, enum: -> { Increase::Models::Transaction::Source::CardSettlement::Interchange::Currency } - # @!parse - # # Interchange assessed as a part of this transaction. - # # - # # @param amount [String] - # # @param code [String, nil] - # # @param currency [Symbol, Increase::Models::Transaction::Source::CardSettlement::Interchange::Currency] - # # - # def initialize(amount:, code:, currency:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(amount:, code:, currency:) + # Interchange assessed as a part of this transaction. + # + # @param amount [String] + # @param code [String, nil] + # @param currency [Symbol, Increase::Models::Transaction::Source::CardSettlement::Interchange::Currency] # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the interchange # reimbursement. @@ -2937,11 +2584,8 @@ module Currency # US Dollar (USD) USD = :USD - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -2967,16 +2611,12 @@ class NetworkIdentifiers < Increase::Internal::Type::BaseModel # @return [String, nil] required :transaction_id, String, nil?: true - # @!parse - # # Network-specific identifiers for this refund. - # # - # # @param acquirer_business_id [String] - # # @param acquirer_reference_number [String] - # # @param transaction_id [String, nil] - # # - # def initialize(acquirer_business_id:, acquirer_reference_number:, transaction_id:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(acquirer_business_id:, acquirer_reference_number:, transaction_id:) + # Network-specific identifiers for this refund. + # + # @param acquirer_business_id [String] + # @param acquirer_reference_number [String] + # @param transaction_id [String, nil] end # @see Increase::Models::Transaction::Source::CardSettlement#purchase_details @@ -3051,38 +2691,20 @@ class PurchaseDetails < Increase::Internal::Type::BaseModel -> { Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::Travel }, nil?: true - # @!parse - # # Additional details about the card purchase, such as tax and industry-specific - # # fields. - # # - # # @param car_rental [Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::CarRental, nil] - # # @param customer_reference_identifier [String, nil] - # # @param local_tax_amount [Integer, nil] - # # @param local_tax_currency [String, nil] - # # @param lodging [Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::Lodging, nil] - # # @param national_tax_amount [Integer, nil] - # # @param national_tax_currency [String, nil] - # # @param purchase_identifier [String, nil] - # # @param purchase_identifier_format [Symbol, Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::PurchaseIdentifierFormat, nil] - # # @param travel [Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::Travel, nil] - # # - # def initialize( - # car_rental:, - # customer_reference_identifier:, - # local_tax_amount:, - # local_tax_currency:, - # lodging:, - # national_tax_amount:, - # national_tax_currency:, - # purchase_identifier:, - # purchase_identifier_format:, - # travel:, - # ** - # ) - # super - # end - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(car_rental:, customer_reference_identifier:, local_tax_amount:, local_tax_currency:, lodging:, national_tax_amount:, national_tax_currency:, purchase_identifier:, purchase_identifier_format:, travel:) + # Additional details about the card purchase, such as tax and industry-specific + # fields. + # + # @param car_rental [Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::CarRental, nil] + # @param customer_reference_identifier [String, nil] + # @param local_tax_amount [Integer, nil] + # @param local_tax_currency [String, nil] + # @param lodging [Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::Lodging, nil] + # @param national_tax_amount [Integer, nil] + # @param national_tax_currency [String, nil] + # @param purchase_identifier [String, nil] + # @param purchase_identifier_format [Symbol, Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::PurchaseIdentifierFormat, nil] + # @param travel [Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::Travel, nil] # @see Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails#car_rental class CarRental < Increase::Internal::Type::BaseModel @@ -3194,49 +2816,25 @@ class CarRental < Increase::Internal::Type::BaseModel # @return [String, nil] required :weekly_rental_rate_currency, String, nil?: true - # @!parse - # # Fields specific to car rentals. - # # - # # @param car_class_code [String, nil] - # # @param checkout_date [Date, nil] - # # @param daily_rental_rate_amount [Integer, nil] - # # @param daily_rental_rate_currency [String, nil] - # # @param days_rented [Integer, nil] - # # @param extra_charges [Symbol, Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::CarRental::ExtraCharges, nil] - # # @param fuel_charges_amount [Integer, nil] - # # @param fuel_charges_currency [String, nil] - # # @param insurance_charges_amount [Integer, nil] - # # @param insurance_charges_currency [String, nil] - # # @param no_show_indicator [Symbol, Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::CarRental::NoShowIndicator, nil] - # # @param one_way_drop_off_charges_amount [Integer, nil] - # # @param one_way_drop_off_charges_currency [String, nil] - # # @param renter_name [String, nil] - # # @param weekly_rental_rate_amount [Integer, nil] - # # @param weekly_rental_rate_currency [String, nil] - # # - # def initialize( - # car_class_code:, - # checkout_date:, - # daily_rental_rate_amount:, - # daily_rental_rate_currency:, - # days_rented:, - # extra_charges:, - # fuel_charges_amount:, - # fuel_charges_currency:, - # insurance_charges_amount:, - # insurance_charges_currency:, - # no_show_indicator:, - # one_way_drop_off_charges_amount:, - # one_way_drop_off_charges_currency:, - # renter_name:, - # weekly_rental_rate_amount:, - # weekly_rental_rate_currency:, - # ** - # ) - # super - # end - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(car_class_code:, checkout_date:, daily_rental_rate_amount:, daily_rental_rate_currency:, days_rented:, extra_charges:, fuel_charges_amount:, fuel_charges_currency:, insurance_charges_amount:, insurance_charges_currency:, no_show_indicator:, one_way_drop_off_charges_amount:, one_way_drop_off_charges_currency:, renter_name:, weekly_rental_rate_amount:, weekly_rental_rate_currency:) + # Fields specific to car rentals. + # + # @param car_class_code [String, nil] + # @param checkout_date [Date, nil] + # @param daily_rental_rate_amount [Integer, nil] + # @param daily_rental_rate_currency [String, nil] + # @param days_rented [Integer, nil] + # @param extra_charges [Symbol, Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::CarRental::ExtraCharges, nil] + # @param fuel_charges_amount [Integer, nil] + # @param fuel_charges_currency [String, nil] + # @param insurance_charges_amount [Integer, nil] + # @param insurance_charges_currency [String, nil] + # @param no_show_indicator [Symbol, Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::CarRental::NoShowIndicator, nil] + # @param one_way_drop_off_charges_amount [Integer, nil] + # @param one_way_drop_off_charges_currency [String, nil] + # @param renter_name [String, nil] + # @param weekly_rental_rate_amount [Integer, nil] + # @param weekly_rental_rate_currency [String, nil] # Additional charges (gas, late fee, etc.) being billed. # @@ -3262,11 +2860,8 @@ module ExtraCharges # Parking violation PARKING_VIOLATION = :parking_violation - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # An indicator that the cardholder is being billed for a reserved vehicle that was @@ -3282,11 +2877,8 @@ module NoShowIndicator # No show for specialized vehicle NO_SHOW_FOR_SPECIALIZED_VEHICLE = :no_show_for_specialized_vehicle - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -3399,49 +2991,25 @@ class Lodging < Increase::Internal::Type::BaseModel # @return [String, nil] required :total_tax_currency, String, nil?: true - # @!parse - # # Fields specific to lodging. - # # - # # @param check_in_date [Date, nil] - # # @param daily_room_rate_amount [Integer, nil] - # # @param daily_room_rate_currency [String, nil] - # # @param extra_charges [Symbol, Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::Lodging::ExtraCharges, nil] - # # @param folio_cash_advances_amount [Integer, nil] - # # @param folio_cash_advances_currency [String, nil] - # # @param food_beverage_charges_amount [Integer, nil] - # # @param food_beverage_charges_currency [String, nil] - # # @param no_show_indicator [Symbol, Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::Lodging::NoShowIndicator, nil] - # # @param prepaid_expenses_amount [Integer, nil] - # # @param prepaid_expenses_currency [String, nil] - # # @param room_nights [Integer, nil] - # # @param total_room_tax_amount [Integer, nil] - # # @param total_room_tax_currency [String, nil] - # # @param total_tax_amount [Integer, nil] - # # @param total_tax_currency [String, nil] - # # - # def initialize( - # check_in_date:, - # daily_room_rate_amount:, - # daily_room_rate_currency:, - # extra_charges:, - # folio_cash_advances_amount:, - # folio_cash_advances_currency:, - # food_beverage_charges_amount:, - # food_beverage_charges_currency:, - # no_show_indicator:, - # prepaid_expenses_amount:, - # prepaid_expenses_currency:, - # room_nights:, - # total_room_tax_amount:, - # total_room_tax_currency:, - # total_tax_amount:, - # total_tax_currency:, - # ** - # ) - # super - # end - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(check_in_date:, daily_room_rate_amount:, daily_room_rate_currency:, extra_charges:, folio_cash_advances_amount:, folio_cash_advances_currency:, food_beverage_charges_amount:, food_beverage_charges_currency:, no_show_indicator:, prepaid_expenses_amount:, prepaid_expenses_currency:, room_nights:, total_room_tax_amount:, total_room_tax_currency:, total_tax_amount:, total_tax_currency:) + # Fields specific to lodging. + # + # @param check_in_date [Date, nil] + # @param daily_room_rate_amount [Integer, nil] + # @param daily_room_rate_currency [String, nil] + # @param extra_charges [Symbol, Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::Lodging::ExtraCharges, nil] + # @param folio_cash_advances_amount [Integer, nil] + # @param folio_cash_advances_currency [String, nil] + # @param food_beverage_charges_amount [Integer, nil] + # @param food_beverage_charges_currency [String, nil] + # @param no_show_indicator [Symbol, Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::Lodging::NoShowIndicator, nil] + # @param prepaid_expenses_amount [Integer, nil] + # @param prepaid_expenses_currency [String, nil] + # @param room_nights [Integer, nil] + # @param total_room_tax_amount [Integer, nil] + # @param total_room_tax_currency [String, nil] + # @param total_tax_amount [Integer, nil] + # @param total_tax_currency [String, nil] # Additional charges (phone, late check-out, etc.) being billed. # @@ -3470,11 +3038,8 @@ module ExtraCharges # Laundry LAUNDRY = :laundry - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # Indicator that the cardholder is being billed for a reserved room that was not @@ -3490,11 +3055,8 @@ module NoShowIndicator # No show NO_SHOW = :no_show - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -3519,11 +3081,8 @@ module PurchaseIdentifierFormat # Invoice number INVOICE_NUMBER = :invoice_number - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails#travel @@ -3610,41 +3169,21 @@ class Travel < Increase::Internal::Type::BaseModel -> { Increase::Internal::Type::ArrayOf[Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::Travel::TripLeg] }, nil?: true - # @!parse - # # Fields specific to travel. - # # - # # @param ancillary [Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::Travel::Ancillary, nil] - # # @param computerized_reservation_system [String, nil] - # # @param credit_reason_indicator [Symbol, Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::Travel::CreditReasonIndicator, nil] - # # @param departure_date [Date, nil] - # # @param origination_city_airport_code [String, nil] - # # @param passenger_name [String, nil] - # # @param restricted_ticket_indicator [Symbol, Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::Travel::RestrictedTicketIndicator, nil] - # # @param ticket_change_indicator [Symbol, Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::Travel::TicketChangeIndicator, nil] - # # @param ticket_number [String, nil] - # # @param travel_agency_code [String, nil] - # # @param travel_agency_name [String, nil] - # # @param trip_legs [Array, nil] - # # - # def initialize( - # ancillary:, - # computerized_reservation_system:, - # credit_reason_indicator:, - # departure_date:, - # origination_city_airport_code:, - # passenger_name:, - # restricted_ticket_indicator:, - # ticket_change_indicator:, - # ticket_number:, - # travel_agency_code:, - # travel_agency_name:, - # trip_legs:, - # ** - # ) - # super - # end - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(ancillary:, computerized_reservation_system:, credit_reason_indicator:, departure_date:, origination_city_airport_code:, passenger_name:, restricted_ticket_indicator:, ticket_change_indicator:, ticket_number:, travel_agency_code:, travel_agency_name:, trip_legs:) + # Fields specific to travel. + # + # @param ancillary [Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::Travel::Ancillary, nil] + # @param computerized_reservation_system [String, nil] + # @param credit_reason_indicator [Symbol, Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::Travel::CreditReasonIndicator, nil] + # @param departure_date [Date, nil] + # @param origination_city_airport_code [String, nil] + # @param passenger_name [String, nil] + # @param restricted_ticket_indicator [Symbol, Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::Travel::RestrictedTicketIndicator, nil] + # @param ticket_change_indicator [Symbol, Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::Travel::TicketChangeIndicator, nil] + # @param ticket_number [String, nil] + # @param travel_agency_code [String, nil] + # @param travel_agency_name [String, nil] + # @param trip_legs [Array, nil] # @see Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::Travel#ancillary class Ancillary < Increase::Internal::Type::BaseModel @@ -3683,27 +3222,14 @@ class Ancillary < Increase::Internal::Type::BaseModel # @return [String, nil] required :ticket_document_number, String, nil?: true - # @!parse - # # Ancillary purchases in addition to the airfare. - # # - # # @param connected_ticket_document_number [String, nil] - # # @param credit_reason_indicator [Symbol, Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::Travel::Ancillary::CreditReasonIndicator, nil] - # # @param passenger_name_or_description [String, nil] - # # @param services [Array] - # # @param ticket_document_number [String, nil] - # # - # def initialize( - # connected_ticket_document_number:, - # credit_reason_indicator:, - # passenger_name_or_description:, - # services:, - # ticket_document_number:, - # ** - # ) - # super - # end - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(connected_ticket_document_number:, credit_reason_indicator:, passenger_name_or_description:, services:, ticket_document_number:) + # Ancillary purchases in addition to the airfare. + # + # @param connected_ticket_document_number [String, nil] + # @param credit_reason_indicator [Symbol, Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::Travel::Ancillary::CreditReasonIndicator, nil] + # @param passenger_name_or_description [String, nil] + # @param services [Array] + # @param ticket_document_number [String, nil] # Indicates the reason for a credit to the cardholder. # @@ -3725,11 +3251,8 @@ module CreditReasonIndicator # Other OTHER = :other - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end class Service < Increase::Internal::Type::BaseModel @@ -3747,13 +3270,9 @@ class Service < Increase::Internal::Type::BaseModel # @return [String, nil] required :sub_category, String, nil?: true - # @!parse - # # @param category [Symbol, Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::Travel::Ancillary::Service::Category, nil] - # # @param sub_category [String, nil] - # # - # def initialize(category:, sub_category:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(category:, sub_category:) + # @param category [Symbol, Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::Travel::Ancillary::Service::Category, nil] + # @param sub_category [String, nil] # Category of the ancillary service. # @@ -3833,11 +3352,8 @@ module Category # Wi-fi WIFI = :wifi - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -3868,11 +3384,8 @@ module CreditReasonIndicator # Partial refund of airline ticket PARTIAL_REFUND_OF_AIRLINE_TICKET = :partial_refund_of_airline_ticket - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # Indicates whether this ticket is non-refundable. @@ -3887,11 +3400,8 @@ module RestrictedTicketIndicator # Restricted non-refundable ticket RESTRICTED_NON_REFUNDABLE_TICKET = :restricted_non_refundable_ticket - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # Indicates why a ticket was changed. @@ -3909,11 +3419,8 @@ module TicketChangeIndicator # New ticket NEW_TICKET = :new_ticket - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end class TripLeg < Increase::Internal::Type::BaseModel @@ -3955,27 +3462,13 @@ class TripLeg < Increase::Internal::Type::BaseModel enum: -> { Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::Travel::TripLeg::StopOverCode }, nil?: true - # @!parse - # # @param carrier_code [String, nil] - # # @param destination_city_airport_code [String, nil] - # # @param fare_basis_code [String, nil] - # # @param flight_number [String, nil] - # # @param service_class [String, nil] - # # @param stop_over_code [Symbol, Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::Travel::TripLeg::StopOverCode, nil] - # # - # def initialize( - # carrier_code:, - # destination_city_airport_code:, - # fare_basis_code:, - # flight_number:, - # service_class:, - # stop_over_code:, - # ** - # ) - # super - # end - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(carrier_code:, destination_city_airport_code:, fare_basis_code:, flight_number:, service_class:, stop_over_code:) + # @param carrier_code [String, nil] + # @param destination_city_airport_code [String, nil] + # @param fare_basis_code [String, nil] + # @param flight_number [String, nil] + # @param service_class [String, nil] + # @param stop_over_code [Symbol, Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::Travel::TripLeg::StopOverCode, nil] # Indicates whether a stopover is allowed on this ticket. # @@ -3992,11 +3485,8 @@ module StopOverCode # Stop over not allowed STOP_OVER_NOT_ALLOWED = :stop_over_not_allowed - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end @@ -4011,11 +3501,8 @@ module Type CARD_SETTLEMENT = :card_settlement - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -4053,21 +3540,17 @@ class CashbackPayment < Increase::Internal::Type::BaseModel # @return [Time] required :period_start, Time - # @!parse - # # A Cashback Payment object. This field will be present in the JSON response if - # # and only if `category` is equal to `cashback_payment`. A Cashback Payment - # # represents the cashback paid to a cardholder for a given period. Cashback is - # # usually paid monthly for the prior month's transactions. - # # - # # @param accrued_on_card_id [String, nil] - # # @param amount [Integer] - # # @param currency [Symbol, Increase::Models::Transaction::Source::CashbackPayment::Currency] - # # @param period_end [Time] - # # @param period_start [Time] - # # - # def initialize(accrued_on_card_id:, amount:, currency:, period_end:, period_start:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(accrued_on_card_id:, amount:, currency:, period_end:, period_start:) + # A Cashback Payment object. This field will be present in the JSON response if + # and only if `category` is equal to `cashback_payment`. A Cashback Payment + # represents the cashback paid to a cardholder for a given period. Cashback is + # usually paid monthly for the prior month's transactions. + # + # @param accrued_on_card_id [String, nil] + # @param amount [Integer] + # @param currency [Symbol, Increase::Models::Transaction::Source::CashbackPayment::Currency] + # @param period_end [Time] + # @param period_start [Time] # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction # currency. @@ -4094,11 +3577,8 @@ module Currency # US Dollar (USD) USD = :USD - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -4196,11 +3676,8 @@ module Category # The Transaction was made for an undocumented or deprecated reason. OTHER = :other - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Increase::Models::Transaction::Source#check_deposit_acceptance @@ -4251,35 +3728,20 @@ class CheckDepositAcceptance < Increase::Internal::Type::BaseModel # @return [String, nil] required :serial_number, String, nil?: true - # @!parse - # # A Check Deposit Acceptance object. This field will be present in the JSON - # # response if and only if `category` is equal to `check_deposit_acceptance`. A - # # Check Deposit Acceptance is created when a Check Deposit is processed and its - # # details confirmed. Check Deposits may be returned by the receiving bank, which - # # will appear as a Check Deposit Return. - # # - # # @param account_number [String] - # # @param amount [Integer] - # # @param auxiliary_on_us [String, nil] - # # @param check_deposit_id [String] - # # @param currency [Symbol, Increase::Models::Transaction::Source::CheckDepositAcceptance::Currency] - # # @param routing_number [String] - # # @param serial_number [String, nil] - # # - # def initialize( - # account_number:, - # amount:, - # auxiliary_on_us:, - # check_deposit_id:, - # currency:, - # routing_number:, - # serial_number:, - # ** - # ) - # super - # end - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(account_number:, amount:, auxiliary_on_us:, check_deposit_id:, currency:, routing_number:, serial_number:) + # A Check Deposit Acceptance object. This field will be present in the JSON + # response if and only if `category` is equal to `check_deposit_acceptance`. A + # Check Deposit Acceptance is created when a Check Deposit is processed and its + # details confirmed. Check Deposits may be returned by the receiving bank, which + # will appear as a Check Deposit Return. + # + # @param account_number [String] + # @param amount [Integer] + # @param auxiliary_on_us [String, nil] + # @param check_deposit_id [String] + # @param currency [Symbol, Increase::Models::Transaction::Source::CheckDepositAcceptance::Currency] + # @param routing_number [String] + # @param serial_number [String, nil] # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the # transaction's currency. @@ -4306,11 +3768,8 @@ module Currency # US Dollar (USD) USD = :USD - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -4357,24 +3816,20 @@ class CheckDepositReturn < Increase::Internal::Type::BaseModel # @return [String] required :transaction_id, String - # @!parse - # # A Check Deposit Return object. This field will be present in the JSON response - # # if and only if `category` is equal to `check_deposit_return`. A Check Deposit - # # Return is created when a Check Deposit is returned by the bank holding the - # # account it was drawn against. Check Deposits may be returned for a variety of - # # reasons, including insufficient funds or a mismatched account number. Usually, - # # checks are returned within the first 7 days after the deposit is made. - # # - # # @param amount [Integer] - # # @param check_deposit_id [String] - # # @param currency [Symbol, Increase::Models::Transaction::Source::CheckDepositReturn::Currency] - # # @param return_reason [Symbol, Increase::Models::Transaction::Source::CheckDepositReturn::ReturnReason] - # # @param returned_at [Time] - # # @param transaction_id [String] - # # - # def initialize(amount:, check_deposit_id:, currency:, return_reason:, returned_at:, transaction_id:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(amount:, check_deposit_id:, currency:, return_reason:, returned_at:, transaction_id:) + # A Check Deposit Return object. This field will be present in the JSON response + # if and only if `category` is equal to `check_deposit_return`. A Check Deposit + # Return is created when a Check Deposit is returned by the bank holding the + # account it was drawn against. Check Deposits may be returned for a variety of + # reasons, including insufficient funds or a mismatched account number. Usually, + # checks are returned within the first 7 days after the deposit is made. + # + # @param amount [Integer] + # @param check_deposit_id [String] + # @param currency [Symbol, Increase::Models::Transaction::Source::CheckDepositReturn::Currency] + # @param return_reason [Symbol, Increase::Models::Transaction::Source::CheckDepositReturn::ReturnReason] + # @param returned_at [Time] + # @param transaction_id [String] # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the # transaction's currency. @@ -4401,11 +3856,8 @@ module Currency # US Dollar (USD) USD = :USD - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # Why this check was returned by the bank holding the account it was drawn @@ -4493,11 +3945,8 @@ module ReturnReason # The bank sold this account and no longer services this customer. BRANCH_OR_ACCOUNT_SOLD = :branch_or_account_sold - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -4557,36 +4006,20 @@ class CheckTransferDeposit < Increase::Internal::Type::BaseModel # @return [Symbol, Increase::Models::Transaction::Source::CheckTransferDeposit::Type] required :type, enum: -> { Increase::Models::Transaction::Source::CheckTransferDeposit::Type } - # @!parse - # # A Check Transfer Deposit object. This field will be present in the JSON response - # # if and only if `category` is equal to `check_transfer_deposit`. An Inbound Check - # # is a check drawn on an Increase account that has been deposited by an external - # # bank account. These types of checks are not pre-registered. - # # - # # @param back_image_file_id [String, nil] - # # @param bank_of_first_deposit_routing_number [String, nil] - # # @param deposited_at [Time] - # # @param front_image_file_id [String, nil] - # # @param inbound_check_deposit_id [String, nil] - # # @param transaction_id [String, nil] - # # @param transfer_id [String, nil] - # # @param type [Symbol, Increase::Models::Transaction::Source::CheckTransferDeposit::Type] - # # - # def initialize( - # back_image_file_id:, - # bank_of_first_deposit_routing_number:, - # deposited_at:, - # front_image_file_id:, - # inbound_check_deposit_id:, - # transaction_id:, - # transfer_id:, - # type:, - # ** - # ) - # super - # end - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(back_image_file_id:, bank_of_first_deposit_routing_number:, deposited_at:, front_image_file_id:, inbound_check_deposit_id:, transaction_id:, transfer_id:, type:) + # A Check Transfer Deposit object. This field will be present in the JSON response + # if and only if `category` is equal to `check_transfer_deposit`. An Inbound Check + # is a check drawn on an Increase account that has been deposited by an external + # bank account. These types of checks are not pre-registered. + # + # @param back_image_file_id [String, nil] + # @param bank_of_first_deposit_routing_number [String, nil] + # @param deposited_at [Time] + # @param front_image_file_id [String, nil] + # @param inbound_check_deposit_id [String, nil] + # @param transaction_id [String, nil] + # @param transfer_id [String, nil] + # @param type [Symbol, Increase::Models::Transaction::Source::CheckTransferDeposit::Type] # A constant representing the object's type. For this resource it will always be # `check_transfer_deposit`. @@ -4597,11 +4030,8 @@ module Type CHECK_TRANSFER_DEPOSIT = :check_transfer_deposit - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -4633,19 +4063,15 @@ class FeePayment < Increase::Internal::Type::BaseModel # @return [String, nil] required :program_id, String, nil?: true - # @!parse - # # A Fee Payment object. This field will be present in the JSON response if and - # # only if `category` is equal to `fee_payment`. A Fee Payment represents a payment - # # made to Increase. - # # - # # @param amount [Integer] - # # @param currency [Symbol, Increase::Models::Transaction::Source::FeePayment::Currency] - # # @param fee_period_start [Date] - # # @param program_id [String, nil] - # # - # def initialize(amount:, currency:, fee_period_start:, program_id:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(amount:, currency:, fee_period_start:, program_id:) + # A Fee Payment object. This field will be present in the JSON response if and + # only if `category` is equal to `fee_payment`. A Fee Payment represents a payment + # made to Increase. + # + # @param amount [Integer] + # @param currency [Symbol, Increase::Models::Transaction::Source::FeePayment::Currency] + # @param fee_period_start [Date] + # @param program_id [String, nil] # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction # currency. @@ -4672,11 +4098,8 @@ module Currency # US Dollar (USD) USD = :USD - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -4754,42 +4177,23 @@ class InboundACHTransfer < Increase::Internal::Type::BaseModel # @return [String] required :transfer_id, String - # @!parse - # # An Inbound ACH Transfer Intention object. This field will be present in the JSON - # # response if and only if `category` is equal to `inbound_ach_transfer`. An - # # Inbound ACH Transfer Intention is created when an ACH transfer is initiated at - # # another bank and received by Increase. - # # - # # @param addenda [Increase::Models::Transaction::Source::InboundACHTransfer::Addenda, nil] - # # @param amount [Integer] - # # @param originator_company_descriptive_date [String, nil] - # # @param originator_company_discretionary_data [String, nil] - # # @param originator_company_entry_description [String] - # # @param originator_company_id [String] - # # @param originator_company_name [String] - # # @param receiver_id_number [String, nil] - # # @param receiver_name [String, nil] - # # @param trace_number [String] - # # @param transfer_id [String] - # # - # def initialize( - # addenda:, - # amount:, - # originator_company_descriptive_date:, - # originator_company_discretionary_data:, - # originator_company_entry_description:, - # originator_company_id:, - # originator_company_name:, - # receiver_id_number:, - # receiver_name:, - # trace_number:, - # transfer_id:, - # ** - # ) - # super - # end - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(addenda:, amount:, originator_company_descriptive_date:, originator_company_discretionary_data:, originator_company_entry_description:, originator_company_id:, originator_company_name:, receiver_id_number:, receiver_name:, trace_number:, transfer_id:) + # An Inbound ACH Transfer Intention object. This field will be present in the JSON + # response if and only if `category` is equal to `inbound_ach_transfer`. An + # Inbound ACH Transfer Intention is created when an ACH transfer is initiated at + # another bank and received by Increase. + # + # @param addenda [Increase::Models::Transaction::Source::InboundACHTransfer::Addenda, nil] + # @param amount [Integer] + # @param originator_company_descriptive_date [String, nil] + # @param originator_company_discretionary_data [String, nil] + # @param originator_company_entry_description [String] + # @param originator_company_id [String] + # @param originator_company_name [String] + # @param receiver_id_number [String, nil] + # @param receiver_name [String, nil] + # @param trace_number [String] + # @param transfer_id [String] # @see Increase::Models::Transaction::Source::InboundACHTransfer#addenda class Addenda < Increase::Internal::Type::BaseModel @@ -4808,15 +4212,11 @@ class Addenda < Increase::Internal::Type::BaseModel -> { Increase::Models::Transaction::Source::InboundACHTransfer::Addenda::Freeform }, nil?: true - # @!parse - # # Additional information sent from the originator. - # # - # # @param category [Symbol, Increase::Models::Transaction::Source::InboundACHTransfer::Addenda::Category] - # # @param freeform [Increase::Models::Transaction::Source::InboundACHTransfer::Addenda::Freeform, nil] - # # - # def initialize(category:, freeform:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(category:, freeform:) + # Additional information sent from the originator. + # + # @param category [Symbol, Increase::Models::Transaction::Source::InboundACHTransfer::Addenda::Category] + # @param freeform [Increase::Models::Transaction::Source::InboundACHTransfer::Addenda::Freeform, nil] # The type of addendum. # @@ -4827,11 +4227,8 @@ module Category # Unstructured addendum. FREEFORM = :freeform - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Increase::Models::Transaction::Source::InboundACHTransfer::Addenda#freeform @@ -4843,14 +4240,10 @@ class Freeform < Increase::Internal::Type::BaseModel required :entries, -> { Increase::Internal::Type::ArrayOf[Increase::Models::Transaction::Source::InboundACHTransfer::Addenda::Freeform::Entry] } - # @!parse - # # Unstructured `payment_related_information` passed through by the originator. - # # - # # @param entries [Array] - # # - # def initialize(entries:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(entries:) + # Unstructured `payment_related_information` passed through by the originator. + # + # @param entries [Array] class Entry < Increase::Internal::Type::BaseModel # @!attribute payment_related_information @@ -4859,12 +4252,8 @@ class Entry < Increase::Internal::Type::BaseModel # @return [String] required :payment_related_information, String - # @!parse - # # @param payment_related_information [String] - # # - # def initialize(payment_related_information:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(payment_related_information:) + # @param payment_related_information [String] end end end @@ -4878,18 +4267,14 @@ class InboundACHTransferReturnIntention < Increase::Internal::Type::BaseModel # @return [String] required :inbound_ach_transfer_id, String - # @!parse - # # An Inbound ACH Transfer Return Intention object. This field will be present in - # # the JSON response if and only if `category` is equal to - # # `inbound_ach_transfer_return_intention`. An Inbound ACH Transfer Return - # # Intention is created when an ACH transfer is initiated at another bank and - # # returned by Increase. - # # - # # @param inbound_ach_transfer_id [String] - # # - # def initialize(inbound_ach_transfer_id:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(inbound_ach_transfer_id:) + # An Inbound ACH Transfer Return Intention object. This field will be present in + # the JSON response if and only if `category` is equal to + # `inbound_ach_transfer_return_intention`. An Inbound ACH Transfer Return + # Intention is created when an ACH transfer is initiated at another bank and + # returned by Increase. + # + # @param inbound_ach_transfer_id [String] end # @see Increase::Models::Transaction::Source#inbound_check_adjustment @@ -4912,19 +4297,15 @@ class InboundCheckAdjustment < Increase::Internal::Type::BaseModel # @return [Symbol, Increase::Models::Transaction::Source::InboundCheckAdjustment::Reason] required :reason, enum: -> { Increase::Models::Transaction::Source::InboundCheckAdjustment::Reason } - # @!parse - # # An Inbound Check Adjustment object. This field will be present in the JSON - # # response if and only if `category` is equal to `inbound_check_adjustment`. An - # # Inbound Check Adjustment is created when Increase receives an adjustment for a - # # check or return deposited through Check21. - # # - # # @param adjusted_transaction_id [String] - # # @param amount [Integer] - # # @param reason [Symbol, Increase::Models::Transaction::Source::InboundCheckAdjustment::Reason] - # # - # def initialize(adjusted_transaction_id:, amount:, reason:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(adjusted_transaction_id:, amount:, reason:) + # An Inbound Check Adjustment object. This field will be present in the JSON + # response if and only if `category` is equal to `inbound_check_adjustment`. An + # Inbound Check Adjustment is created when Increase receives an adjustment for a + # check or return deposited through Check21. + # + # @param adjusted_transaction_id [String] + # @param amount [Integer] + # @param reason [Symbol, Increase::Models::Transaction::Source::InboundCheckAdjustment::Reason] # The reason for the adjustment. # @@ -4944,11 +4325,8 @@ module Reason # The recipient was not able to process the check. This usually happens for e.g., low quality images. NON_CONFORMING_ITEM = :non_conforming_item - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -4966,19 +4344,15 @@ class InboundCheckDepositReturnIntention < Increase::Internal::Type::BaseModel # @return [String, nil] required :transfer_id, String, nil?: true - # @!parse - # # An Inbound Check Deposit Return Intention object. This field will be present in - # # the JSON response if and only if `category` is equal to - # # `inbound_check_deposit_return_intention`. An Inbound Check Deposit Return - # # Intention is created when Increase receives an Inbound Check and the User - # # requests that it be returned. - # # - # # @param inbound_check_deposit_id [String] - # # @param transfer_id [String, nil] - # # - # def initialize(inbound_check_deposit_id:, transfer_id:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(inbound_check_deposit_id:, transfer_id:) + # An Inbound Check Deposit Return Intention object. This field will be present in + # the JSON response if and only if `category` is equal to + # `inbound_check_deposit_return_intention`. An Inbound Check Deposit Return + # Intention is created when Increase receives an Inbound Check and the User + # requests that it be returned. + # + # @param inbound_check_deposit_id [String] + # @param transfer_id [String, nil] end # @see Increase::Models::Transaction::Source#inbound_real_time_payments_transfer_confirmation @@ -5040,39 +4414,22 @@ class InboundRealTimePaymentsTransferConfirmation < Increase::Internal::Type::Ba # @return [String] required :transfer_id, String - # @!parse - # # An Inbound Real-Time Payments Transfer Confirmation object. This field will be - # # present in the JSON response if and only if `category` is equal to - # # `inbound_real_time_payments_transfer_confirmation`. An Inbound Real-Time - # # Payments Transfer Confirmation is created when a Real-Time Payments transfer is - # # initiated at another bank and received by Increase. - # # - # # @param amount [Integer] - # # @param creditor_name [String] - # # @param currency [Symbol, Increase::Models::Transaction::Source::InboundRealTimePaymentsTransferConfirmation::Currency] - # # @param debtor_account_number [String] - # # @param debtor_name [String] - # # @param debtor_routing_number [String] - # # @param remittance_information [String, nil] - # # @param transaction_identification [String] - # # @param transfer_id [String] - # # - # def initialize( - # amount:, - # creditor_name:, - # currency:, - # debtor_account_number:, - # debtor_name:, - # debtor_routing_number:, - # remittance_information:, - # transaction_identification:, - # transfer_id:, - # ** - # ) - # super - # end - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(amount:, creditor_name:, currency:, debtor_account_number:, debtor_name:, debtor_routing_number:, remittance_information:, transaction_identification:, transfer_id:) + # An Inbound Real-Time Payments Transfer Confirmation object. This field will be + # present in the JSON response if and only if `category` is equal to + # `inbound_real_time_payments_transfer_confirmation`. An Inbound Real-Time + # Payments Transfer Confirmation is created when a Real-Time Payments transfer is + # initiated at another bank and received by Increase. + # + # @param amount [Integer] + # @param creditor_name [String] + # @param currency [Symbol, Increase::Models::Transaction::Source::InboundRealTimePaymentsTransferConfirmation::Currency] + # @param debtor_account_number [String] + # @param debtor_name [String] + # @param debtor_routing_number [String] + # @param remittance_information [String, nil] + # @param transaction_identification [String] + # @param transfer_id [String] # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code of the transfer's # currency. This will always be "USD" for a Real-Time Payments transfer. @@ -5099,11 +4456,8 @@ module Currency # US Dollar (USD) USD = :USD - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -5174,39 +4528,21 @@ class InboundRealTimePaymentsTransferDecline < Increase::Internal::Type::BaseMod # @return [String] required :transfer_id, String - # @!parse - # # An Inbound Real-Time Payments Transfer Decline object. This field will be - # # present in the JSON response if and only if `category` is equal to - # # `inbound_real_time_payments_transfer_decline`. - # # - # # @param amount [Integer] - # # @param creditor_name [String] - # # @param currency [Symbol, Increase::Models::Transaction::Source::InboundRealTimePaymentsTransferDecline::Currency] - # # @param debtor_account_number [String] - # # @param debtor_name [String] - # # @param debtor_routing_number [String] - # # @param reason [Symbol, Increase::Models::Transaction::Source::InboundRealTimePaymentsTransferDecline::Reason] - # # @param remittance_information [String, nil] - # # @param transaction_identification [String] - # # @param transfer_id [String] - # # - # def initialize( - # amount:, - # creditor_name:, - # currency:, - # debtor_account_number:, - # debtor_name:, - # debtor_routing_number:, - # reason:, - # remittance_information:, - # transaction_identification:, - # transfer_id:, - # ** - # ) - # super - # end - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(amount:, creditor_name:, currency:, debtor_account_number:, debtor_name:, debtor_routing_number:, reason:, remittance_information:, transaction_identification:, transfer_id:) + # An Inbound Real-Time Payments Transfer Decline object. This field will be + # present in the JSON response if and only if `category` is equal to + # `inbound_real_time_payments_transfer_decline`. + # + # @param amount [Integer] + # @param creditor_name [String] + # @param currency [Symbol, Increase::Models::Transaction::Source::InboundRealTimePaymentsTransferDecline::Currency] + # @param debtor_account_number [String] + # @param debtor_name [String] + # @param debtor_routing_number [String] + # @param reason [Symbol, Increase::Models::Transaction::Source::InboundRealTimePaymentsTransferDecline::Reason] + # @param remittance_information [String, nil] + # @param transaction_identification [String] + # @param transfer_id [String] # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code of the declined # transfer's currency. This will always be "USD" for a Real-Time Payments @@ -5234,11 +4570,8 @@ module Currency # US Dollar (USD) USD = :USD - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # Why the transfer was declined. @@ -5265,11 +4598,8 @@ module Reason # Your account is not enabled to receive Real-Time Payments transfers. REAL_TIME_PAYMENTS_NOT_ENABLED = :real_time_payments_not_enabled - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -5382,55 +4712,30 @@ class InboundWireReversal < Increase::Internal::Type::BaseModel # @return [String] required :wire_transfer_id, String - # @!parse - # # An Inbound Wire Reversal object. This field will be present in the JSON response - # # if and only if `category` is equal to `inbound_wire_reversal`. An Inbound Wire - # # Reversal represents a reversal of a wire transfer that was initiated via - # # Increase. The other bank is sending the money back. This most often happens when - # # the original destination account details were incorrect. - # # - # # @param amount [Integer] - # # @param created_at [Time] - # # @param description [String] - # # @param financial_institution_to_financial_institution_information [String, nil] - # # @param input_cycle_date [Date] - # # @param input_message_accountability_data [String] - # # @param input_sequence_number [String] - # # @param input_source [String] - # # @param originator_routing_number [String, nil] - # # @param previous_message_input_cycle_date [Date] - # # @param previous_message_input_message_accountability_data [String] - # # @param previous_message_input_sequence_number [String] - # # @param previous_message_input_source [String] - # # @param receiver_financial_institution_information [String, nil] - # # @param sender_reference [String, nil] - # # @param transaction_id [String] - # # @param wire_transfer_id [String] - # # - # def initialize( - # amount:, - # created_at:, - # description:, - # financial_institution_to_financial_institution_information:, - # input_cycle_date:, - # input_message_accountability_data:, - # input_sequence_number:, - # input_source:, - # originator_routing_number:, - # previous_message_input_cycle_date:, - # previous_message_input_message_accountability_data:, - # previous_message_input_sequence_number:, - # previous_message_input_source:, - # receiver_financial_institution_information:, - # sender_reference:, - # transaction_id:, - # wire_transfer_id:, - # ** - # ) - # super - # end - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(amount:, created_at:, description:, financial_institution_to_financial_institution_information:, input_cycle_date:, input_message_accountability_data:, input_sequence_number:, input_source:, originator_routing_number:, previous_message_input_cycle_date:, previous_message_input_message_accountability_data:, previous_message_input_sequence_number:, previous_message_input_source:, receiver_financial_institution_information:, sender_reference:, transaction_id:, wire_transfer_id:) + # An Inbound Wire Reversal object. This field will be present in the JSON response + # if and only if `category` is equal to `inbound_wire_reversal`. An Inbound Wire + # Reversal represents a reversal of a wire transfer that was initiated via + # Increase. The other bank is sending the money back. This most often happens when + # the original destination account details were incorrect. + # + # @param amount [Integer] + # @param created_at [Time] + # @param description [String] + # @param financial_institution_to_financial_institution_information [String, nil] + # @param input_cycle_date [Date] + # @param input_message_accountability_data [String] + # @param input_sequence_number [String] + # @param input_source [String] + # @param originator_routing_number [String, nil] + # @param previous_message_input_cycle_date [Date] + # @param previous_message_input_message_accountability_data [String] + # @param previous_message_input_sequence_number [String] + # @param previous_message_input_source [String] + # @param receiver_financial_institution_information [String, nil] + # @param sender_reference [String, nil] + # @param transaction_id [String] + # @param wire_transfer_id [String] end # @see Increase::Models::Transaction::Source#inbound_wire_transfer @@ -5552,58 +4857,31 @@ class InboundWireTransfer < Increase::Internal::Type::BaseModel # @return [String] required :transfer_id, String - # @!parse - # # An Inbound Wire Transfer Intention object. This field will be present in the - # # JSON response if and only if `category` is equal to `inbound_wire_transfer`. An - # # Inbound Wire Transfer Intention is created when a wire transfer is initiated at - # # another bank and received by Increase. - # # - # # @param amount [Integer] - # # @param beneficiary_address_line1 [String, nil] - # # @param beneficiary_address_line2 [String, nil] - # # @param beneficiary_address_line3 [String, nil] - # # @param beneficiary_name [String, nil] - # # @param beneficiary_reference [String, nil] - # # @param description [String] - # # @param input_message_accountability_data [String, nil] - # # @param originator_address_line1 [String, nil] - # # @param originator_address_line2 [String, nil] - # # @param originator_address_line3 [String, nil] - # # @param originator_name [String, nil] - # # @param originator_routing_number [String, nil] - # # @param originator_to_beneficiary_information [String, nil] - # # @param originator_to_beneficiary_information_line1 [String, nil] - # # @param originator_to_beneficiary_information_line2 [String, nil] - # # @param originator_to_beneficiary_information_line3 [String, nil] - # # @param originator_to_beneficiary_information_line4 [String, nil] - # # @param transfer_id [String] - # # - # def initialize( - # amount:, - # beneficiary_address_line1:, - # beneficiary_address_line2:, - # beneficiary_address_line3:, - # beneficiary_name:, - # beneficiary_reference:, - # description:, - # input_message_accountability_data:, - # originator_address_line1:, - # originator_address_line2:, - # originator_address_line3:, - # originator_name:, - # originator_routing_number:, - # originator_to_beneficiary_information:, - # originator_to_beneficiary_information_line1:, - # originator_to_beneficiary_information_line2:, - # originator_to_beneficiary_information_line3:, - # originator_to_beneficiary_information_line4:, - # transfer_id:, - # ** - # ) - # super - # end - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(amount:, beneficiary_address_line1:, beneficiary_address_line2:, beneficiary_address_line3:, beneficiary_name:, beneficiary_reference:, description:, input_message_accountability_data:, originator_address_line1:, originator_address_line2:, originator_address_line3:, originator_name:, originator_routing_number:, originator_to_beneficiary_information:, originator_to_beneficiary_information_line1:, originator_to_beneficiary_information_line2:, originator_to_beneficiary_information_line3:, originator_to_beneficiary_information_line4:, transfer_id:) + # An Inbound Wire Transfer Intention object. This field will be present in the + # JSON response if and only if `category` is equal to `inbound_wire_transfer`. An + # Inbound Wire Transfer Intention is created when a wire transfer is initiated at + # another bank and received by Increase. + # + # @param amount [Integer] + # @param beneficiary_address_line1 [String, nil] + # @param beneficiary_address_line2 [String, nil] + # @param beneficiary_address_line3 [String, nil] + # @param beneficiary_name [String, nil] + # @param beneficiary_reference [String, nil] + # @param description [String] + # @param input_message_accountability_data [String, nil] + # @param originator_address_line1 [String, nil] + # @param originator_address_line2 [String, nil] + # @param originator_address_line3 [String, nil] + # @param originator_name [String, nil] + # @param originator_routing_number [String, nil] + # @param originator_to_beneficiary_information [String, nil] + # @param originator_to_beneficiary_information_line1 [String, nil] + # @param originator_to_beneficiary_information_line2 [String, nil] + # @param originator_to_beneficiary_information_line3 [String, nil] + # @param originator_to_beneficiary_information_line4 [String, nil] + # @param transfer_id [String] end # @see Increase::Models::Transaction::Source#inbound_wire_transfer_reversal @@ -5614,18 +4892,14 @@ class InboundWireTransferReversal < Increase::Internal::Type::BaseModel # @return [String] required :inbound_wire_transfer_id, String - # @!parse - # # An Inbound Wire Transfer Reversal Intention object. This field will be present - # # in the JSON response if and only if `category` is equal to - # # `inbound_wire_transfer_reversal`. An Inbound Wire Transfer Reversal Intention is - # # created when Increase has received a wire and the User requests that it be - # # reversed. - # # - # # @param inbound_wire_transfer_id [String] - # # - # def initialize(inbound_wire_transfer_id:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(inbound_wire_transfer_id:) + # An Inbound Wire Transfer Reversal Intention object. This field will be present + # in the JSON response if and only if `category` is equal to + # `inbound_wire_transfer_reversal`. An Inbound Wire Transfer Reversal Intention is + # created when Increase has received a wire and the User requests that it be + # reversed. + # + # @param inbound_wire_transfer_id [String] end # @see Increase::Models::Transaction::Source#interest_payment @@ -5662,21 +4936,17 @@ class InterestPayment < Increase::Internal::Type::BaseModel # @return [Time] required :period_start, Time - # @!parse - # # An Interest Payment object. This field will be present in the JSON response if - # # and only if `category` is equal to `interest_payment`. An Interest Payment - # # represents a payment of interest on an account. Interest is usually paid - # # monthly. - # # - # # @param accrued_on_account_id [String] - # # @param amount [Integer] - # # @param currency [Symbol, Increase::Models::Transaction::Source::InterestPayment::Currency] - # # @param period_end [Time] - # # @param period_start [Time] - # # - # def initialize(accrued_on_account_id:, amount:, currency:, period_end:, period_start:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(accrued_on_account_id:, amount:, currency:, period_end:, period_start:) + # An Interest Payment object. This field will be present in the JSON response if + # and only if `category` is equal to `interest_payment`. An Interest Payment + # represents a payment of interest on an account. Interest is usually paid + # monthly. + # + # @param accrued_on_account_id [String] + # @param amount [Integer] + # @param currency [Symbol, Increase::Models::Transaction::Source::InterestPayment::Currency] + # @param period_end [Time] + # @param period_start [Time] # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction # currency. @@ -5703,11 +4973,8 @@ module Currency # US Dollar (USD) USD = :USD - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -5734,18 +5001,14 @@ class InternalSource < Increase::Internal::Type::BaseModel # @return [Symbol, Increase::Models::Transaction::Source::InternalSource::Reason] required :reason, enum: -> { Increase::Models::Transaction::Source::InternalSource::Reason } - # @!parse - # # An Internal Source object. This field will be present in the JSON response if - # # and only if `category` is equal to `internal_source`. A transaction between the - # # user and Increase. See the `reason` attribute for more information. - # # - # # @param amount [Integer] - # # @param currency [Symbol, Increase::Models::Transaction::Source::InternalSource::Currency] - # # @param reason [Symbol, Increase::Models::Transaction::Source::InternalSource::Reason] - # # - # def initialize(amount:, currency:, reason:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(amount:, currency:, reason:) + # An Internal Source object. This field will be present in the JSON response if + # and only if `category` is equal to `internal_source`. A transaction between the + # user and Increase. See the `reason` attribute for more information. + # + # @param amount [Integer] + # @param currency [Symbol, Increase::Models::Transaction::Source::InternalSource::Currency] + # @param reason [Symbol, Increase::Models::Transaction::Source::InternalSource::Reason] # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction # currency. @@ -5772,11 +5035,8 @@ module Currency # US Dollar (USD) USD = :USD - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # An Internal Source is a transaction between you and Increase. This describes the @@ -5831,11 +5091,8 @@ module Reason # Sample funds return SAMPLE_FUNDS_RETURN = :sample_funds_return - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end @@ -5871,31 +5128,18 @@ class RealTimePaymentsTransferAcknowledgement < Increase::Internal::Type::BaseMo # @return [String] required :transfer_id, String - # @!parse - # # A Real-Time Payments Transfer Acknowledgement object. This field will be present - # # in the JSON response if and only if `category` is equal to - # # `real_time_payments_transfer_acknowledgement`. A Real-Time Payments Transfer - # # Acknowledgement is created when a Real-Time Payments Transfer sent from Increase - # # is acknowledged by the receiving bank. - # # - # # @param amount [Integer] - # # @param destination_account_number [String] - # # @param destination_routing_number [String] - # # @param remittance_information [String] - # # @param transfer_id [String] - # # - # def initialize( - # amount:, - # destination_account_number:, - # destination_routing_number:, - # remittance_information:, - # transfer_id:, - # ** - # ) - # super - # end - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(amount:, destination_account_number:, destination_routing_number:, remittance_information:, transfer_id:) + # A Real-Time Payments Transfer Acknowledgement object. This field will be present + # in the JSON response if and only if `category` is equal to + # `real_time_payments_transfer_acknowledgement`. A Real-Time Payments Transfer + # Acknowledgement is created when a Real-Time Payments Transfer sent from Increase + # is acknowledged by the receiving bank. + # + # @param amount [Integer] + # @param destination_account_number [String] + # @param destination_routing_number [String] + # @param remittance_information [String] + # @param transfer_id [String] end # @see Increase::Models::Transaction::Source#sample_funds @@ -5906,16 +5150,12 @@ class SampleFunds < Increase::Internal::Type::BaseModel # @return [String] required :originator, String - # @!parse - # # A Sample Funds object. This field will be present in the JSON response if and - # # only if `category` is equal to `sample_funds`. Sample funds for testing - # # purposes. - # # - # # @param originator [String] - # # - # def initialize(originator:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(originator:) + # A Sample Funds object. This field will be present in the JSON response if and + # only if `category` is equal to `sample_funds`. Sample funds for testing + # purposes. + # + # @param originator [String] end # @see Increase::Models::Transaction::Source#wire_transfer_intention @@ -5950,20 +5190,16 @@ class WireTransferIntention < Increase::Internal::Type::BaseModel # @return [String] required :transfer_id, String - # @!parse - # # A Wire Transfer Intention object. This field will be present in the JSON - # # response if and only if `category` is equal to `wire_transfer_intention`. A Wire - # # Transfer initiated via Increase and sent to a different bank. - # # - # # @param account_number [String] - # # @param amount [Integer] - # # @param message_to_recipient [String] - # # @param routing_number [String] - # # @param transfer_id [String] - # # - # def initialize(account_number:, amount:, message_to_recipient:, routing_number:, transfer_id:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(account_number:, amount:, message_to_recipient:, routing_number:, transfer_id:) + # A Wire Transfer Intention object. This field will be present in the JSON + # response if and only if `category` is equal to `wire_transfer_intention`. A Wire + # Transfer initiated via Increase and sent to a different bank. + # + # @param account_number [String] + # @param amount [Integer] + # @param message_to_recipient [String] + # @param routing_number [String] + # @param transfer_id [String] end end @@ -5976,11 +5212,8 @@ module Type TRANSACTION = :transaction - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end diff --git a/lib/increase/models/transaction_list_params.rb b/lib/increase/models/transaction_list_params.rb index 8e4275053..c2ac029de 100644 --- a/lib/increase/models/transaction_list_params.rb +++ b/lib/increase/models/transaction_list_params.rb @@ -4,96 +4,56 @@ module Increase module Models # @see Increase::Resources::Transactions#list class TransactionListParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters - # @!attribute [r] account_id + # @!attribute account_id # Filter Transactions for those belonging to the specified Account. # # @return [String, nil] optional :account_id, String - # @!parse - # # @return [String] - # attr_writer :account_id - - # @!attribute [r] category + # @!attribute category # # @return [Increase::Models::TransactionListParams::Category, nil] optional :category, -> { Increase::Models::TransactionListParams::Category } - # @!parse - # # @return [Increase::Models::TransactionListParams::Category] - # attr_writer :category - - # @!attribute [r] created_at + # @!attribute created_at # # @return [Increase::Models::TransactionListParams::CreatedAt, nil] optional :created_at, -> { Increase::Models::TransactionListParams::CreatedAt } - # @!parse - # # @return [Increase::Models::TransactionListParams::CreatedAt] - # attr_writer :created_at - - # @!attribute [r] cursor + # @!attribute cursor # Return the page of entries after this one. # # @return [String, nil] optional :cursor, String - # @!parse - # # @return [String] - # attr_writer :cursor - - # @!attribute [r] limit + # @!attribute limit # Limit the size of the list that is returned. The default (and maximum) is 100 # objects. # # @return [Integer, nil] optional :limit, Integer - # @!parse - # # @return [Integer] - # attr_writer :limit - - # @!attribute [r] route_id + # @!attribute route_id # Filter Transactions for those belonging to the specified route. This could be a # Card ID or an Account Number ID. # # @return [String, nil] optional :route_id, String - # @!parse - # # @return [String] - # attr_writer :route_id - - # @!parse - # # @param account_id [String] - # # @param category [Increase::Models::TransactionListParams::Category] - # # @param created_at [Increase::Models::TransactionListParams::CreatedAt] - # # @param cursor [String] - # # @param limit [Integer] - # # @param route_id [String] - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize( - # account_id: nil, - # category: nil, - # created_at: nil, - # cursor: nil, - # limit: nil, - # route_id: nil, - # request_options: {}, - # ** - # ) - # super - # end - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(account_id: nil, category: nil, created_at: nil, cursor: nil, limit: nil, route_id: nil, request_options: {}) + # @param account_id [String] + # @param category [Increase::Models::TransactionListParams::Category] + # @param created_at [Increase::Models::TransactionListParams::CreatedAt] + # @param cursor [String] + # @param limit [Integer] + # @param route_id [String] + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] class Category < Increase::Internal::Type::BaseModel - # @!attribute [r] in_ + # @!attribute in_ # Return results whose value is in the provided list. For GET requests, this # should be encoded as a comma-delimited string, such as `?in=one,two,three`. # @@ -102,16 +62,8 @@ class Category < Increase::Internal::Type::BaseModel -> { Increase::Internal::Type::ArrayOf[enum: Increase::Models::TransactionListParams::Category::In] }, api_name: :in - # @!parse - # # @return [Array] - # attr_writer :in_ - - # @!parse - # # @param in_ [Array] - # # - # def initialize(in_: nil, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(in_: nil) + # @param in_ [Array] module In extend Increase::Internal::Type::Enum @@ -203,68 +155,45 @@ module In # The Transaction was made for an undocumented or deprecated reason. OTHER = :other - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end class CreatedAt < Increase::Internal::Type::BaseModel - # @!attribute [r] after + # @!attribute after # Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) # timestamp. # # @return [Time, nil] optional :after, Time - # @!parse - # # @return [Time] - # attr_writer :after - - # @!attribute [r] before + # @!attribute before # Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) # timestamp. # # @return [Time, nil] optional :before, Time - # @!parse - # # @return [Time] - # attr_writer :before - - # @!attribute [r] on_or_after + # @!attribute on_or_after # Return results on or after this # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. # # @return [Time, nil] optional :on_or_after, Time - # @!parse - # # @return [Time] - # attr_writer :on_or_after - - # @!attribute [r] on_or_before + # @!attribute on_or_before # Return results on or before this # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. # # @return [Time, nil] optional :on_or_before, Time - # @!parse - # # @return [Time] - # attr_writer :on_or_before - - # @!parse - # # @param after [Time] - # # @param before [Time] - # # @param on_or_after [Time] - # # @param on_or_before [Time] - # # - # def initialize(after: nil, before: nil, on_or_after: nil, on_or_before: nil, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(after: nil, before: nil, on_or_after: nil, on_or_before: nil) + # @param after [Time] + # @param before [Time] + # @param on_or_after [Time] + # @param on_or_before [Time] end end end diff --git a/lib/increase/models/transaction_retrieve_params.rb b/lib/increase/models/transaction_retrieve_params.rb index 35caded4b..908f927b5 100644 --- a/lib/increase/models/transaction_retrieve_params.rb +++ b/lib/increase/models/transaction_retrieve_params.rb @@ -4,16 +4,11 @@ module Increase module Models # @see Increase::Resources::Transactions#retrieve class TransactionRetrieveParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters - # @!parse - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(request_options: {}, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(request_options: {}) + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/increase/models/wire_drawdown_request.rb b/lib/increase/models/wire_drawdown_request.rb index 48234a37f..042e4db07 100644 --- a/lib/increase/models/wire_drawdown_request.rb +++ b/lib/increase/models/wire_drawdown_request.rb @@ -138,61 +138,32 @@ class WireDrawdownRequest < Increase::Internal::Type::BaseModel # @return [Symbol, Increase::Models::WireDrawdownRequest::Type] required :type, enum: -> { Increase::Models::WireDrawdownRequest::Type } - # @!parse - # # Wire drawdown requests enable you to request that someone else send you a wire. - # # This feature is in beta; reach out to - # # [support@increase.com](mailto:support@increase.com) to learn more. - # # - # # @param id [String] - # # @param account_number_id [String] - # # @param amount [Integer] - # # @param created_at [Time] - # # @param currency [String] - # # @param fulfillment_inbound_wire_transfer_id [String, nil] - # # @param idempotency_key [String, nil] - # # @param message_to_recipient [String] - # # @param originator_address_line1 [String, nil] - # # @param originator_address_line2 [String, nil] - # # @param originator_address_line3 [String, nil] - # # @param originator_name [String, nil] - # # @param recipient_account_number [String] - # # @param recipient_address_line1 [String, nil] - # # @param recipient_address_line2 [String, nil] - # # @param recipient_address_line3 [String, nil] - # # @param recipient_name [String, nil] - # # @param recipient_routing_number [String] - # # @param status [Symbol, Increase::Models::WireDrawdownRequest::Status] - # # @param submission [Increase::Models::WireDrawdownRequest::Submission, nil] - # # @param type [Symbol, Increase::Models::WireDrawdownRequest::Type] - # # - # def initialize( - # id:, - # account_number_id:, - # amount:, - # created_at:, - # currency:, - # fulfillment_inbound_wire_transfer_id:, - # idempotency_key:, - # message_to_recipient:, - # originator_address_line1:, - # originator_address_line2:, - # originator_address_line3:, - # originator_name:, - # recipient_account_number:, - # recipient_address_line1:, - # recipient_address_line2:, - # recipient_address_line3:, - # recipient_name:, - # recipient_routing_number:, - # status:, - # submission:, - # type:, - # ** - # ) - # super - # end - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(id:, account_number_id:, amount:, created_at:, currency:, fulfillment_inbound_wire_transfer_id:, idempotency_key:, message_to_recipient:, originator_address_line1:, originator_address_line2:, originator_address_line3:, originator_name:, recipient_account_number:, recipient_address_line1:, recipient_address_line2:, recipient_address_line3:, recipient_name:, recipient_routing_number:, status:, submission:, type:) + # Wire drawdown requests enable you to request that someone else send you a wire. + # This feature is in beta; reach out to + # [support@increase.com](mailto:support@increase.com) to learn more. + # + # @param id [String] + # @param account_number_id [String] + # @param amount [Integer] + # @param created_at [Time] + # @param currency [String] + # @param fulfillment_inbound_wire_transfer_id [String, nil] + # @param idempotency_key [String, nil] + # @param message_to_recipient [String] + # @param originator_address_line1 [String, nil] + # @param originator_address_line2 [String, nil] + # @param originator_address_line3 [String, nil] + # @param originator_name [String, nil] + # @param recipient_account_number [String] + # @param recipient_address_line1 [String, nil] + # @param recipient_address_line2 [String, nil] + # @param recipient_address_line3 [String, nil] + # @param recipient_name [String, nil] + # @param recipient_routing_number [String] + # @param status [Symbol, Increase::Models::WireDrawdownRequest::Status] + # @param submission [Increase::Models::WireDrawdownRequest::Submission, nil] + # @param type [Symbol, Increase::Models::WireDrawdownRequest::Type] # The lifecycle status of the drawdown request. # @@ -212,11 +183,8 @@ module Status # The drawdown request has been refused by the recipient. REFUSED = :refused - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Increase::Models::WireDrawdownRequest#submission @@ -228,15 +196,11 @@ class Submission < Increase::Internal::Type::BaseModel # @return [String] required :input_message_accountability_data, String - # @!parse - # # After the drawdown request is submitted to Fedwire, this will contain - # # supplemental details. - # # - # # @param input_message_accountability_data [String] - # # - # def initialize(input_message_accountability_data:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(input_message_accountability_data:) + # After the drawdown request is submitted to Fedwire, this will contain + # supplemental details. + # + # @param input_message_accountability_data [String] end # A constant representing the object's type. For this resource it will always be @@ -248,11 +212,8 @@ module Type WIRE_DRAWDOWN_REQUEST = :wire_drawdown_request - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end diff --git a/lib/increase/models/wire_drawdown_request_create_params.rb b/lib/increase/models/wire_drawdown_request_create_params.rb index faec32da5..1ec4dfb3d 100644 --- a/lib/increase/models/wire_drawdown_request_create_params.rb +++ b/lib/increase/models/wire_drawdown_request_create_params.rb @@ -4,8 +4,7 @@ module Increase module Models # @see Increase::Resources::WireDrawdownRequests#create class WireDrawdownRequestCreateParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters # @!attribute account_number_id @@ -44,7 +43,7 @@ class WireDrawdownRequestCreateParams < Increase::Internal::Type::BaseModel # @return [String] required :recipient_routing_number, String - # @!attribute [r] originator_address_line1 + # @!attribute originator_address_line1 # The drawdown request originator's address line 1. This is only necessary if # you're requesting a payment to a commingled account. Otherwise, we'll use the # associated entity's details. @@ -52,11 +51,7 @@ class WireDrawdownRequestCreateParams < Increase::Internal::Type::BaseModel # @return [String, nil] optional :originator_address_line1, String - # @!parse - # # @return [String] - # attr_writer :originator_address_line1 - - # @!attribute [r] originator_address_line2 + # @!attribute originator_address_line2 # The drawdown request originator's address line 2. This is only necessary if # you're requesting a payment to a commingled account. Otherwise, we'll use the # associated entity's details. @@ -64,11 +59,7 @@ class WireDrawdownRequestCreateParams < Increase::Internal::Type::BaseModel # @return [String, nil] optional :originator_address_line2, String - # @!parse - # # @return [String] - # attr_writer :originator_address_line2 - - # @!attribute [r] originator_address_line3 + # @!attribute originator_address_line3 # The drawdown request originator's address line 3. This is only necessary if # you're requesting a payment to a commingled account. Otherwise, we'll use the # associated entity's details. @@ -76,11 +67,7 @@ class WireDrawdownRequestCreateParams < Increase::Internal::Type::BaseModel # @return [String, nil] optional :originator_address_line3, String - # @!parse - # # @return [String] - # attr_writer :originator_address_line3 - - # @!attribute [r] originator_name + # @!attribute originator_name # The drawdown request originator's name. This is only necessary if you're # requesting a payment to a commingled account. Otherwise, we'll use the # associated entity's details. @@ -88,77 +75,39 @@ class WireDrawdownRequestCreateParams < Increase::Internal::Type::BaseModel # @return [String, nil] optional :originator_name, String - # @!parse - # # @return [String] - # attr_writer :originator_name - - # @!attribute [r] recipient_address_line1 + # @!attribute recipient_address_line1 # Line 1 of the drawdown request's recipient's address. # # @return [String, nil] optional :recipient_address_line1, String - # @!parse - # # @return [String] - # attr_writer :recipient_address_line1 - - # @!attribute [r] recipient_address_line2 + # @!attribute recipient_address_line2 # Line 2 of the drawdown request's recipient's address. # # @return [String, nil] optional :recipient_address_line2, String - # @!parse - # # @return [String] - # attr_writer :recipient_address_line2 - - # @!attribute [r] recipient_address_line3 + # @!attribute recipient_address_line3 # Line 3 of the drawdown request's recipient's address. # # @return [String, nil] optional :recipient_address_line3, String - # @!parse - # # @return [String] - # attr_writer :recipient_address_line3 - - # @!parse - # # @param account_number_id [String] - # # @param amount [Integer] - # # @param message_to_recipient [String] - # # @param recipient_account_number [String] - # # @param recipient_name [String] - # # @param recipient_routing_number [String] - # # @param originator_address_line1 [String] - # # @param originator_address_line2 [String] - # # @param originator_address_line3 [String] - # # @param originator_name [String] - # # @param recipient_address_line1 [String] - # # @param recipient_address_line2 [String] - # # @param recipient_address_line3 [String] - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize( - # account_number_id:, - # amount:, - # message_to_recipient:, - # recipient_account_number:, - # recipient_name:, - # recipient_routing_number:, - # originator_address_line1: nil, - # originator_address_line2: nil, - # originator_address_line3: nil, - # originator_name: nil, - # recipient_address_line1: nil, - # recipient_address_line2: nil, - # recipient_address_line3: nil, - # request_options: {}, - # ** - # ) - # super - # end - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(account_number_id:, amount:, message_to_recipient:, recipient_account_number:, recipient_name:, recipient_routing_number:, originator_address_line1: nil, originator_address_line2: nil, originator_address_line3: nil, originator_name: nil, recipient_address_line1: nil, recipient_address_line2: nil, recipient_address_line3: nil, request_options: {}) + # @param account_number_id [String] + # @param amount [Integer] + # @param message_to_recipient [String] + # @param recipient_account_number [String] + # @param recipient_name [String] + # @param recipient_routing_number [String] + # @param originator_address_line1 [String] + # @param originator_address_line2 [String] + # @param originator_address_line3 [String] + # @param originator_name [String] + # @param recipient_address_line1 [String] + # @param recipient_address_line2 [String] + # @param recipient_address_line3 [String] + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/increase/models/wire_drawdown_request_list_params.rb b/lib/increase/models/wire_drawdown_request_list_params.rb index efec266d5..037269146 100644 --- a/lib/increase/models/wire_drawdown_request_list_params.rb +++ b/lib/increase/models/wire_drawdown_request_list_params.rb @@ -4,21 +4,16 @@ module Increase module Models # @see Increase::Resources::WireDrawdownRequests#list class WireDrawdownRequestListParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters - # @!attribute [r] cursor + # @!attribute cursor # Return the page of entries after this one. # # @return [String, nil] optional :cursor, String - # @!parse - # # @return [String] - # attr_writer :cursor - - # @!attribute [r] idempotency_key + # @!attribute idempotency_key # Filter records to the one with the specified `idempotency_key` you chose for # that object. This value is unique across Increase and is used to ensure that a # request is only processed once. Learn more about @@ -27,43 +22,27 @@ class WireDrawdownRequestListParams < Increase::Internal::Type::BaseModel # @return [String, nil] optional :idempotency_key, String - # @!parse - # # @return [String] - # attr_writer :idempotency_key - - # @!attribute [r] limit + # @!attribute limit # Limit the size of the list that is returned. The default (and maximum) is 100 # objects. # # @return [Integer, nil] optional :limit, Integer - # @!parse - # # @return [Integer] - # attr_writer :limit - - # @!attribute [r] status + # @!attribute status # # @return [Increase::Models::WireDrawdownRequestListParams::Status, nil] optional :status, -> { Increase::Models::WireDrawdownRequestListParams::Status } - # @!parse - # # @return [Increase::Models::WireDrawdownRequestListParams::Status] - # attr_writer :status - - # @!parse - # # @param cursor [String] - # # @param idempotency_key [String] - # # @param limit [Integer] - # # @param status [Increase::Models::WireDrawdownRequestListParams::Status] - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(cursor: nil, idempotency_key: nil, limit: nil, status: nil, request_options: {}, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(cursor: nil, idempotency_key: nil, limit: nil, status: nil, request_options: {}) + # @param cursor [String] + # @param idempotency_key [String] + # @param limit [Integer] + # @param status [Increase::Models::WireDrawdownRequestListParams::Status] + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] class Status < Increase::Internal::Type::BaseModel - # @!attribute [r] in_ + # @!attribute in_ # Filter Wire Drawdown Requests for those with the specified status. For GET # requests, this should be encoded as a comma-delimited string, such as # `?in=one,two,three`. @@ -73,16 +52,8 @@ class Status < Increase::Internal::Type::BaseModel -> { Increase::Internal::Type::ArrayOf[enum: Increase::Models::WireDrawdownRequestListParams::Status::In] }, api_name: :in - # @!parse - # # @return [Array] - # attr_writer :in_ - - # @!parse - # # @param in_ [Array] - # # - # def initialize(in_: nil, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(in_: nil) + # @param in_ [Array] module In extend Increase::Internal::Type::Enum @@ -99,11 +70,8 @@ module In # The drawdown request has been refused by the recipient. REFUSED = :refused - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end diff --git a/lib/increase/models/wire_drawdown_request_retrieve_params.rb b/lib/increase/models/wire_drawdown_request_retrieve_params.rb index f28cf9044..ee6454e1d 100644 --- a/lib/increase/models/wire_drawdown_request_retrieve_params.rb +++ b/lib/increase/models/wire_drawdown_request_retrieve_params.rb @@ -4,16 +4,11 @@ module Increase module Models # @see Increase::Resources::WireDrawdownRequests#retrieve class WireDrawdownRequestRetrieveParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters - # @!parse - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(request_options: {}, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(request_options: {}) + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/increase/models/wire_transfer.rb b/lib/increase/models/wire_transfer.rb index d447fd794..b09da6850 100644 --- a/lib/increase/models/wire_transfer.rb +++ b/lib/increase/models/wire_transfer.rb @@ -189,76 +189,39 @@ class WireTransfer < Increase::Internal::Type::BaseModel # @return [Symbol, Increase::Models::WireTransfer::Type] required :type, enum: -> { Increase::Models::WireTransfer::Type } - # @!parse - # # Wire transfers move funds between your Increase account and any other account - # # accessible by Fedwire. - # # - # # @param id [String] - # # @param account_id [String] - # # @param account_number [String] - # # @param amount [Integer] - # # @param approval [Increase::Models::WireTransfer::Approval, nil] - # # @param beneficiary_address_line1 [String, nil] - # # @param beneficiary_address_line2 [String, nil] - # # @param beneficiary_address_line3 [String, nil] - # # @param beneficiary_name [String, nil] - # # @param cancellation [Increase::Models::WireTransfer::Cancellation, nil] - # # @param created_at [Time] - # # @param created_by [Increase::Models::WireTransfer::CreatedBy, nil] - # # @param currency [Symbol, Increase::Models::WireTransfer::Currency] - # # @param external_account_id [String, nil] - # # @param idempotency_key [String, nil] - # # @param message_to_recipient [String, nil] - # # @param network [Symbol, Increase::Models::WireTransfer::Network] - # # @param originator_address_line1 [String, nil] - # # @param originator_address_line2 [String, nil] - # # @param originator_address_line3 [String, nil] - # # @param originator_name [String, nil] - # # @param pending_transaction_id [String, nil] - # # @param reversal [Increase::Models::WireTransfer::Reversal, nil] - # # @param routing_number [String] - # # @param source_account_number_id [String, nil] - # # @param status [Symbol, Increase::Models::WireTransfer::Status] - # # @param submission [Increase::Models::WireTransfer::Submission, nil] - # # @param transaction_id [String, nil] - # # @param type [Symbol, Increase::Models::WireTransfer::Type] - # # - # def initialize( - # id:, - # account_id:, - # account_number:, - # amount:, - # approval:, - # beneficiary_address_line1:, - # beneficiary_address_line2:, - # beneficiary_address_line3:, - # beneficiary_name:, - # cancellation:, - # created_at:, - # created_by:, - # currency:, - # external_account_id:, - # idempotency_key:, - # message_to_recipient:, - # network:, - # originator_address_line1:, - # originator_address_line2:, - # originator_address_line3:, - # originator_name:, - # pending_transaction_id:, - # reversal:, - # routing_number:, - # source_account_number_id:, - # status:, - # submission:, - # transaction_id:, - # type:, - # ** - # ) - # super - # end - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(id:, account_id:, account_number:, amount:, approval:, beneficiary_address_line1:, beneficiary_address_line2:, beneficiary_address_line3:, beneficiary_name:, cancellation:, created_at:, created_by:, currency:, external_account_id:, idempotency_key:, message_to_recipient:, network:, originator_address_line1:, originator_address_line2:, originator_address_line3:, originator_name:, pending_transaction_id:, reversal:, routing_number:, source_account_number_id:, status:, submission:, transaction_id:, type:) + # Wire transfers move funds between your Increase account and any other account + # accessible by Fedwire. + # + # @param id [String] + # @param account_id [String] + # @param account_number [String] + # @param amount [Integer] + # @param approval [Increase::Models::WireTransfer::Approval, nil] + # @param beneficiary_address_line1 [String, nil] + # @param beneficiary_address_line2 [String, nil] + # @param beneficiary_address_line3 [String, nil] + # @param beneficiary_name [String, nil] + # @param cancellation [Increase::Models::WireTransfer::Cancellation, nil] + # @param created_at [Time] + # @param created_by [Increase::Models::WireTransfer::CreatedBy, nil] + # @param currency [Symbol, Increase::Models::WireTransfer::Currency] + # @param external_account_id [String, nil] + # @param idempotency_key [String, nil] + # @param message_to_recipient [String, nil] + # @param network [Symbol, Increase::Models::WireTransfer::Network] + # @param originator_address_line1 [String, nil] + # @param originator_address_line2 [String, nil] + # @param originator_address_line3 [String, nil] + # @param originator_name [String, nil] + # @param pending_transaction_id [String, nil] + # @param reversal [Increase::Models::WireTransfer::Reversal, nil] + # @param routing_number [String] + # @param source_account_number_id [String, nil] + # @param status [Symbol, Increase::Models::WireTransfer::Status] + # @param submission [Increase::Models::WireTransfer::Submission, nil] + # @param transaction_id [String, nil] + # @param type [Symbol, Increase::Models::WireTransfer::Type] # @see Increase::Models::WireTransfer#approval class Approval < Increase::Internal::Type::BaseModel @@ -276,16 +239,12 @@ class Approval < Increase::Internal::Type::BaseModel # @return [String, nil] required :approved_by, String, nil?: true - # @!parse - # # If your account requires approvals for transfers and the transfer was approved, - # # this will contain details of the approval. - # # - # # @param approved_at [Time] - # # @param approved_by [String, nil] - # # - # def initialize(approved_at:, approved_by:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(approved_at:, approved_by:) + # If your account requires approvals for transfers and the transfer was approved, + # this will contain details of the approval. + # + # @param approved_at [Time] + # @param approved_by [String, nil] end # @see Increase::Models::WireTransfer#cancellation @@ -304,16 +263,12 @@ class Cancellation < Increase::Internal::Type::BaseModel # @return [String, nil] required :canceled_by, String, nil?: true - # @!parse - # # If your account requires approvals for transfers and the transfer was not - # # approved, this will contain details of the cancellation. - # # - # # @param canceled_at [Time] - # # @param canceled_by [String, nil] - # # - # def initialize(canceled_at:, canceled_by:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(canceled_at:, canceled_by:) + # If your account requires approvals for transfers and the transfer was not + # approved, this will contain details of the cancellation. + # + # @param canceled_at [Time] + # @param canceled_by [String, nil] end # @see Increase::Models::WireTransfer#created_by @@ -344,17 +299,13 @@ class CreatedBy < Increase::Internal::Type::BaseModel # @return [Increase::Models::WireTransfer::CreatedBy::User, nil] required :user, -> { Increase::Models::WireTransfer::CreatedBy::User }, nil?: true - # @!parse - # # What object created the transfer, either via the API or the dashboard. - # # - # # @param api_key [Increase::Models::WireTransfer::CreatedBy::APIKey, nil] - # # @param category [Symbol, Increase::Models::WireTransfer::CreatedBy::Category] - # # @param oauth_application [Increase::Models::WireTransfer::CreatedBy::OAuthApplication, nil] - # # @param user [Increase::Models::WireTransfer::CreatedBy::User, nil] - # # - # def initialize(api_key:, category:, oauth_application:, user:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(api_key:, category:, oauth_application:, user:) + # What object created the transfer, either via the API or the dashboard. + # + # @param api_key [Increase::Models::WireTransfer::CreatedBy::APIKey, nil] + # @param category [Symbol, Increase::Models::WireTransfer::CreatedBy::Category] + # @param oauth_application [Increase::Models::WireTransfer::CreatedBy::OAuthApplication, nil] + # @param user [Increase::Models::WireTransfer::CreatedBy::User, nil] # @see Increase::Models::WireTransfer::CreatedBy#api_key class APIKey < Increase::Internal::Type::BaseModel @@ -364,14 +315,10 @@ class APIKey < Increase::Internal::Type::BaseModel # @return [String, nil] required :description, String, nil?: true - # @!parse - # # If present, details about the API key that created the transfer. - # # - # # @param description [String, nil] - # # - # def initialize(description:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(description:) + # If present, details about the API key that created the transfer. + # + # @param description [String, nil] end # The type of object that created this transfer. @@ -389,11 +336,8 @@ module Category # A User in the Increase dashboard. Details will be under the `user` object. USER = :user - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Increase::Models::WireTransfer::CreatedBy#oauth_application @@ -404,14 +348,10 @@ class OAuthApplication < Increase::Internal::Type::BaseModel # @return [String] required :name, String - # @!parse - # # If present, details about the OAuth Application that created the transfer. - # # - # # @param name [String] - # # - # def initialize(name:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(name:) + # If present, details about the OAuth Application that created the transfer. + # + # @param name [String] end # @see Increase::Models::WireTransfer::CreatedBy#user @@ -422,14 +362,10 @@ class User < Increase::Internal::Type::BaseModel # @return [String] required :email, String - # @!parse - # # If present, details about the User that created the transfer. - # # - # # @param email [String] - # # - # def initialize(email:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(email:) + # If present, details about the User that created the transfer. + # + # @param email [String] end end @@ -458,11 +394,8 @@ module Currency # US Dollar (USD) USD = :USD - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # The transfer's network. @@ -473,11 +406,8 @@ module Network WIRE = :wire - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Increase::Models::WireTransfer#reversal @@ -589,51 +519,26 @@ class Reversal < Increase::Internal::Type::BaseModel # @return [String] required :wire_transfer_id, String - # @!parse - # # If your transfer is reversed, this will contain details of the reversal. - # # - # # @param amount [Integer] - # # @param created_at [Time] - # # @param description [String] - # # @param financial_institution_to_financial_institution_information [String, nil] - # # @param input_cycle_date [Date] - # # @param input_message_accountability_data [String] - # # @param input_sequence_number [String] - # # @param input_source [String] - # # @param originator_routing_number [String, nil] - # # @param previous_message_input_cycle_date [Date] - # # @param previous_message_input_message_accountability_data [String] - # # @param previous_message_input_sequence_number [String] - # # @param previous_message_input_source [String] - # # @param receiver_financial_institution_information [String, nil] - # # @param sender_reference [String, nil] - # # @param transaction_id [String] - # # @param wire_transfer_id [String] - # # - # def initialize( - # amount:, - # created_at:, - # description:, - # financial_institution_to_financial_institution_information:, - # input_cycle_date:, - # input_message_accountability_data:, - # input_sequence_number:, - # input_source:, - # originator_routing_number:, - # previous_message_input_cycle_date:, - # previous_message_input_message_accountability_data:, - # previous_message_input_sequence_number:, - # previous_message_input_source:, - # receiver_financial_institution_information:, - # sender_reference:, - # transaction_id:, - # wire_transfer_id:, - # ** - # ) - # super - # end - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(amount:, created_at:, description:, financial_institution_to_financial_institution_information:, input_cycle_date:, input_message_accountability_data:, input_sequence_number:, input_source:, originator_routing_number:, previous_message_input_cycle_date:, previous_message_input_message_accountability_data:, previous_message_input_sequence_number:, previous_message_input_source:, receiver_financial_institution_information:, sender_reference:, transaction_id:, wire_transfer_id:) + # If your transfer is reversed, this will contain details of the reversal. + # + # @param amount [Integer] + # @param created_at [Time] + # @param description [String] + # @param financial_institution_to_financial_institution_information [String, nil] + # @param input_cycle_date [Date] + # @param input_message_accountability_data [String] + # @param input_sequence_number [String] + # @param input_source [String] + # @param originator_routing_number [String, nil] + # @param previous_message_input_cycle_date [Date] + # @param previous_message_input_message_accountability_data [String] + # @param previous_message_input_sequence_number [String] + # @param previous_message_input_source [String] + # @param receiver_financial_institution_information [String, nil] + # @param sender_reference [String, nil] + # @param transaction_id [String] + # @param wire_transfer_id [String] end # The lifecycle status of the transfer. @@ -669,11 +574,8 @@ module Status # The transfer has been acknowledged by Fedwire and can be considered complete. COMPLETE = :complete - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end # @see Increase::Models::WireTransfer#submission @@ -690,16 +592,12 @@ class Submission < Increase::Internal::Type::BaseModel # @return [Time] required :submitted_at, Time - # @!parse - # # After the transfer is submitted to Fedwire, this will contain supplemental - # # details. - # # - # # @param input_message_accountability_data [String] - # # @param submitted_at [Time] - # # - # def initialize(input_message_accountability_data:, submitted_at:, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(input_message_accountability_data:, submitted_at:) + # After the transfer is submitted to Fedwire, this will contain supplemental + # details. + # + # @param input_message_accountability_data [String] + # @param submitted_at [Time] end # A constant representing the object's type. For this resource it will always be @@ -711,11 +609,8 @@ module Type WIRE_TRANSFER = :wire_transfer - finalize! - - # @!parse - # # @return [Array] - # def self.values; end + # @!method self.values + # @return [Array] end end end diff --git a/lib/increase/models/wire_transfer_approve_params.rb b/lib/increase/models/wire_transfer_approve_params.rb index d11afa175..f674651a9 100644 --- a/lib/increase/models/wire_transfer_approve_params.rb +++ b/lib/increase/models/wire_transfer_approve_params.rb @@ -4,16 +4,11 @@ module Increase module Models # @see Increase::Resources::WireTransfers#approve class WireTransferApproveParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters - # @!parse - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(request_options: {}, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(request_options: {}) + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/increase/models/wire_transfer_cancel_params.rb b/lib/increase/models/wire_transfer_cancel_params.rb index 4b81df632..532d83a2d 100644 --- a/lib/increase/models/wire_transfer_cancel_params.rb +++ b/lib/increase/models/wire_transfer_cancel_params.rb @@ -4,16 +4,11 @@ module Increase module Models # @see Increase::Resources::WireTransfers#cancel class WireTransferCancelParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters - # @!parse - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(request_options: {}, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(request_options: {}) + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/increase/models/wire_transfer_create_params.rb b/lib/increase/models/wire_transfer_create_params.rb index ff013a488..a9993109f 100644 --- a/lib/increase/models/wire_transfer_create_params.rb +++ b/lib/increase/models/wire_transfer_create_params.rb @@ -4,8 +4,7 @@ module Increase module Models # @see Increase::Resources::WireTransfers#create class WireTransferCreateParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters # @!attribute account_id @@ -32,175 +31,102 @@ class WireTransferCreateParams < Increase::Internal::Type::BaseModel # @return [String] required :message_to_recipient, String - # @!attribute [r] account_number + # @!attribute account_number # The account number for the destination account. # # @return [String, nil] optional :account_number, String - # @!parse - # # @return [String] - # attr_writer :account_number - - # @!attribute [r] beneficiary_address_line1 + # @!attribute beneficiary_address_line1 # The beneficiary's address line 1. # # @return [String, nil] optional :beneficiary_address_line1, String - # @!parse - # # @return [String] - # attr_writer :beneficiary_address_line1 - - # @!attribute [r] beneficiary_address_line2 + # @!attribute beneficiary_address_line2 # The beneficiary's address line 2. # # @return [String, nil] optional :beneficiary_address_line2, String - # @!parse - # # @return [String] - # attr_writer :beneficiary_address_line2 - - # @!attribute [r] beneficiary_address_line3 + # @!attribute beneficiary_address_line3 # The beneficiary's address line 3. # # @return [String, nil] optional :beneficiary_address_line3, String - # @!parse - # # @return [String] - # attr_writer :beneficiary_address_line3 - - # @!attribute [r] external_account_id + # @!attribute external_account_id # The ID of an External Account to initiate a transfer to. If this parameter is # provided, `account_number` and `routing_number` must be absent. # # @return [String, nil] optional :external_account_id, String - # @!parse - # # @return [String] - # attr_writer :external_account_id - - # @!attribute [r] originator_address_line1 + # @!attribute originator_address_line1 # The originator's address line 1. This is only necessary if you're transferring # from a commingled account. Otherwise, we'll use the associated entity's details. # # @return [String, nil] optional :originator_address_line1, String - # @!parse - # # @return [String] - # attr_writer :originator_address_line1 - - # @!attribute [r] originator_address_line2 + # @!attribute originator_address_line2 # The originator's address line 2. This is only necessary if you're transferring # from a commingled account. Otherwise, we'll use the associated entity's details. # # @return [String, nil] optional :originator_address_line2, String - # @!parse - # # @return [String] - # attr_writer :originator_address_line2 - - # @!attribute [r] originator_address_line3 + # @!attribute originator_address_line3 # The originator's address line 3. This is only necessary if you're transferring # from a commingled account. Otherwise, we'll use the associated entity's details. # # @return [String, nil] optional :originator_address_line3, String - # @!parse - # # @return [String] - # attr_writer :originator_address_line3 - - # @!attribute [r] originator_name + # @!attribute originator_name # The originator's name. This is only necessary if you're transferring from a # commingled account. Otherwise, we'll use the associated entity's details. # # @return [String, nil] optional :originator_name, String - # @!parse - # # @return [String] - # attr_writer :originator_name - - # @!attribute [r] require_approval + # @!attribute require_approval # Whether the transfer requires explicit approval via the dashboard or API. # # @return [Boolean, nil] optional :require_approval, Increase::Internal::Type::Boolean - # @!parse - # # @return [Boolean] - # attr_writer :require_approval - - # @!attribute [r] routing_number + # @!attribute routing_number # The American Bankers' Association (ABA) Routing Transit Number (RTN) for the # destination account. # # @return [String, nil] optional :routing_number, String - # @!parse - # # @return [String] - # attr_writer :routing_number - - # @!attribute [r] source_account_number_id + # @!attribute source_account_number_id # The ID of an Account Number that will be passed to the wire's recipient # # @return [String, nil] optional :source_account_number_id, String - # @!parse - # # @return [String] - # attr_writer :source_account_number_id - - # @!parse - # # @param account_id [String] - # # @param amount [Integer] - # # @param beneficiary_name [String] - # # @param message_to_recipient [String] - # # @param account_number [String] - # # @param beneficiary_address_line1 [String] - # # @param beneficiary_address_line2 [String] - # # @param beneficiary_address_line3 [String] - # # @param external_account_id [String] - # # @param originator_address_line1 [String] - # # @param originator_address_line2 [String] - # # @param originator_address_line3 [String] - # # @param originator_name [String] - # # @param require_approval [Boolean] - # # @param routing_number [String] - # # @param source_account_number_id [String] - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize( - # account_id:, - # amount:, - # beneficiary_name:, - # message_to_recipient:, - # account_number: nil, - # beneficiary_address_line1: nil, - # beneficiary_address_line2: nil, - # beneficiary_address_line3: nil, - # external_account_id: nil, - # originator_address_line1: nil, - # originator_address_line2: nil, - # originator_address_line3: nil, - # originator_name: nil, - # require_approval: nil, - # routing_number: nil, - # source_account_number_id: nil, - # request_options: {}, - # ** - # ) - # super - # end - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(account_id:, amount:, beneficiary_name:, message_to_recipient:, account_number: nil, beneficiary_address_line1: nil, beneficiary_address_line2: nil, beneficiary_address_line3: nil, external_account_id: nil, originator_address_line1: nil, originator_address_line2: nil, originator_address_line3: nil, originator_name: nil, require_approval: nil, routing_number: nil, source_account_number_id: nil, request_options: {}) + # @param account_id [String] + # @param amount [Integer] + # @param beneficiary_name [String] + # @param message_to_recipient [String] + # @param account_number [String] + # @param beneficiary_address_line1 [String] + # @param beneficiary_address_line2 [String] + # @param beneficiary_address_line3 [String] + # @param external_account_id [String] + # @param originator_address_line1 [String] + # @param originator_address_line2 [String] + # @param originator_address_line3 [String] + # @param originator_name [String] + # @param require_approval [Boolean] + # @param routing_number [String] + # @param source_account_number_id [String] + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/increase/models/wire_transfer_list_params.rb b/lib/increase/models/wire_transfer_list_params.rb index 0ea73e5c9..49525cce0 100644 --- a/lib/increase/models/wire_transfer_list_params.rb +++ b/lib/increase/models/wire_transfer_list_params.rb @@ -4,50 +4,33 @@ module Increase module Models # @see Increase::Resources::WireTransfers#list class WireTransferListParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters - # @!attribute [r] account_id + # @!attribute account_id # Filter Wire Transfers to those belonging to the specified Account. # # @return [String, nil] optional :account_id, String - # @!parse - # # @return [String] - # attr_writer :account_id - - # @!attribute [r] created_at + # @!attribute created_at # # @return [Increase::Models::WireTransferListParams::CreatedAt, nil] optional :created_at, -> { Increase::Models::WireTransferListParams::CreatedAt } - # @!parse - # # @return [Increase::Models::WireTransferListParams::CreatedAt] - # attr_writer :created_at - - # @!attribute [r] cursor + # @!attribute cursor # Return the page of entries after this one. # # @return [String, nil] optional :cursor, String - # @!parse - # # @return [String] - # attr_writer :cursor - - # @!attribute [r] external_account_id + # @!attribute external_account_id # Filter Wire Transfers to those made to the specified External Account. # # @return [String, nil] optional :external_account_id, String - # @!parse - # # @return [String] - # attr_writer :external_account_id - - # @!attribute [r] idempotency_key + # @!attribute idempotency_key # Filter records to the one with the specified `idempotency_key` you chose for # that object. This value is unique across Increase and is used to ensure that a # request is only processed once. Learn more about @@ -56,99 +39,56 @@ class WireTransferListParams < Increase::Internal::Type::BaseModel # @return [String, nil] optional :idempotency_key, String - # @!parse - # # @return [String] - # attr_writer :idempotency_key - - # @!attribute [r] limit + # @!attribute limit # Limit the size of the list that is returned. The default (and maximum) is 100 # objects. # # @return [Integer, nil] optional :limit, Integer - # @!parse - # # @return [Integer] - # attr_writer :limit - - # @!parse - # # @param account_id [String] - # # @param created_at [Increase::Models::WireTransferListParams::CreatedAt] - # # @param cursor [String] - # # @param external_account_id [String] - # # @param idempotency_key [String] - # # @param limit [Integer] - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize( - # account_id: nil, - # created_at: nil, - # cursor: nil, - # external_account_id: nil, - # idempotency_key: nil, - # limit: nil, - # request_options: {}, - # ** - # ) - # super - # end - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(account_id: nil, created_at: nil, cursor: nil, external_account_id: nil, idempotency_key: nil, limit: nil, request_options: {}) + # @param account_id [String] + # @param created_at [Increase::Models::WireTransferListParams::CreatedAt] + # @param cursor [String] + # @param external_account_id [String] + # @param idempotency_key [String] + # @param limit [Integer] + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] class CreatedAt < Increase::Internal::Type::BaseModel - # @!attribute [r] after + # @!attribute after # Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) # timestamp. # # @return [Time, nil] optional :after, Time - # @!parse - # # @return [Time] - # attr_writer :after - - # @!attribute [r] before + # @!attribute before # Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) # timestamp. # # @return [Time, nil] optional :before, Time - # @!parse - # # @return [Time] - # attr_writer :before - - # @!attribute [r] on_or_after + # @!attribute on_or_after # Return results on or after this # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. # # @return [Time, nil] optional :on_or_after, Time - # @!parse - # # @return [Time] - # attr_writer :on_or_after - - # @!attribute [r] on_or_before + # @!attribute on_or_before # Return results on or before this # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. # # @return [Time, nil] optional :on_or_before, Time - # @!parse - # # @return [Time] - # attr_writer :on_or_before - - # @!parse - # # @param after [Time] - # # @param before [Time] - # # @param on_or_after [Time] - # # @param on_or_before [Time] - # # - # def initialize(after: nil, before: nil, on_or_after: nil, on_or_before: nil, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(after: nil, before: nil, on_or_after: nil, on_or_before: nil) + # @param after [Time] + # @param before [Time] + # @param on_or_after [Time] + # @param on_or_before [Time] end end end diff --git a/lib/increase/models/wire_transfer_retrieve_params.rb b/lib/increase/models/wire_transfer_retrieve_params.rb index 4f387d644..bfda377e4 100644 --- a/lib/increase/models/wire_transfer_retrieve_params.rb +++ b/lib/increase/models/wire_transfer_retrieve_params.rb @@ -4,16 +4,11 @@ module Increase module Models # @see Increase::Resources::WireTransfers#retrieve class WireTransferRetrieveParams < Increase::Internal::Type::BaseModel - # @!parse - # extend Increase::Internal::Type::RequestParameters::Converter + extend Increase::Internal::Type::RequestParameters::Converter include Increase::Internal::Type::RequestParameters - # @!parse - # # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] - # # - # def initialize(request_options: {}, **) = super - - # def initialize: (Hash | Increase::Internal::Type::BaseModel) -> void + # @!method initialize(request_options: {}) + # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}] end end end diff --git a/lib/increase/request_options.rb b/lib/increase/request_options.rb index 0aa4b9687..bb41b7fde 100644 --- a/lib/increase/request_options.rb +++ b/lib/increase/request_options.rb @@ -66,10 +66,9 @@ def self.validate!(opts) optional :timeout, Float # @!parse - # # Returns a new instance of RequestOptions. + # # @!method initialize(values = {}) + # # Returns a new instance of RequestOptions. # # - # # @param values [Hash{Symbol=>Object}] - # # - # def initialize(values = {}) = super + # # @param values [Hash{Symbol=>Object}] end end diff --git a/lib/increase/version.rb b/lib/increase/version.rb index d9f7264d8..8b14b025b 100644 --- a/lib/increase/version.rb +++ b/lib/increase/version.rb @@ -1,5 +1,5 @@ # frozen_string_literal: true module Increase - VERSION = "0.1.0.pre.alpha.10" + VERSION = "0.1.0.pre.alpha.11" end diff --git a/rbi/lib/increase/client.rbi b/rbi/lib/increase/client.rbi index e03bdece0..e0dcdb033 100644 --- a/rbi/lib/increase/client.rbi +++ b/rbi/lib/increase/client.rbi @@ -209,13 +209,14 @@ module Increase # - `production` corresponds to `https://api.increase.com` # - `sandbox` corresponds to `https://sandbox.increase.com` environment: nil, - # Override the default base URL for the API, e.g., `"https://api.example.com/v2/"` - base_url: nil, + # Override the default base URL for the API, e.g., + # `"https://api.example.com/v2/"`. Defaults to `ENV["INCREASE_BASE_URL"]` + base_url: ENV["INCREASE_BASE_URL"], # Max number of retries to attempt after a failed retryable request. - max_retries: DEFAULT_MAX_RETRIES, - timeout: DEFAULT_TIMEOUT_IN_SECONDS, - initial_retry_delay: DEFAULT_INITIAL_RETRY_DELAY, - max_retry_delay: DEFAULT_MAX_RETRY_DELAY, + max_retries: Increase::Client::DEFAULT_MAX_RETRIES, + timeout: Increase::Client::DEFAULT_TIMEOUT_IN_SECONDS, + initial_retry_delay: Increase::Client::DEFAULT_INITIAL_RETRY_DELAY, + max_retry_delay: Increase::Client::DEFAULT_MAX_RETRY_DELAY, idempotency_header: "Idempotency-Key" ); end end diff --git a/rbi/lib/increase/internal.rbi b/rbi/lib/increase/internal.rbi index 528cb8934..1929e1cf5 100644 --- a/rbi/lib/increase/internal.rbi +++ b/rbi/lib/increase/internal.rbi @@ -1,7 +1,6 @@ # typed: strong module Increase - # @api private module Internal # Due to the current WIP status of Shapes support in Sorbet, types referencing # this alias might be refined in the future. diff --git a/rbi/lib/increase/internal/type/array_of.rbi b/rbi/lib/increase/internal/type/array_of.rbi index 4c33e004c..c1d2a31d1 100644 --- a/rbi/lib/increase/internal/type/array_of.rbi +++ b/rbi/lib/increase/internal/type/array_of.rbi @@ -32,6 +32,9 @@ module Increase sig { params(other: T.anything).returns(T::Boolean) } def ==(other); end + sig { returns(Integer) } + def hash; end + # @api private sig do override diff --git a/rbi/lib/increase/internal/type/base_model.rbi b/rbi/lib/increase/internal/type/base_model.rbi index 80dacfb57..f829b91f3 100644 --- a/rbi/lib/increase/internal/type/base_model.rbi +++ b/rbi/lib/increase/internal/type/base_model.rbi @@ -111,11 +111,17 @@ module Increase sig { params(other: T.anything).returns(T::Boolean) } def ==(other); end + + sig { returns(Integer) } + def hash; end end sig { params(other: T.anything).returns(T::Boolean) } def ==(other); end + sig { returns(Integer) } + def hash; end + class << self # @api private sig do @@ -179,6 +185,12 @@ module Increase sig { params(keys: T.nilable(T::Array[Symbol])).returns(Increase::Internal::AnyHash) } def deconstruct_keys(keys); end + class << self + # @api private + sig { params(model: Increase::Internal::Type::BaseModel).returns(Increase::Internal::AnyHash) } + def walk(model); end + end + sig { params(a: T.anything).returns(String) } def to_json(*a); end @@ -195,6 +207,9 @@ module Increase def inspect(depth: 0); end end + sig { returns(String) } + def to_s; end + # @api private sig { returns(String) } def inspect; end diff --git a/rbi/lib/increase/internal/type/base_page.rbi b/rbi/lib/increase/internal/type/base_page.rbi index 328056da6..ef3ebc43a 100644 --- a/rbi/lib/increase/internal/type/base_page.rbi +++ b/rbi/lib/increase/internal/type/base_page.rbi @@ -3,6 +3,8 @@ module Increase module Internal module Type + # @api private + # # This module provides a base implementation for paginated responses in the SDK. module BasePage Elem = type_member(:out) diff --git a/rbi/lib/increase/internal/type/enum.rbi b/rbi/lib/increase/internal/type/enum.rbi index 474ab6ef0..33f4f86b3 100644 --- a/rbi/lib/increase/internal/type/enum.rbi +++ b/rbi/lib/increase/internal/type/enum.rbi @@ -22,18 +22,15 @@ module Increase sig { overridable.returns(T::Array[T.any(NilClass, T::Boolean, Integer, Float, Symbol)]) } def values; end - # @api private - # - # Guard against thread safety issues by instantiating `@values`. - sig { void } - private def finalize!; end - sig { params(other: T.anything).returns(T::Boolean) } def ===(other); end sig { params(other: T.anything).returns(T::Boolean) } def ==(other); end + sig { returns(Integer) } + def hash; end + # @api private # # Unlike with primitives, `Enum` additionally validates that the value is a member diff --git a/rbi/lib/increase/internal/type/hash_of.rbi b/rbi/lib/increase/internal/type/hash_of.rbi index 08292e39c..f977a597b 100644 --- a/rbi/lib/increase/internal/type/hash_of.rbi +++ b/rbi/lib/increase/internal/type/hash_of.rbi @@ -32,6 +32,9 @@ module Increase sig { params(other: T.anything).returns(T::Boolean) } def ==(other); end + sig { returns(Integer) } + def hash; end + # @api private sig do override diff --git a/rbi/lib/increase/internal/type/union.rbi b/rbi/lib/increase/internal/type/union.rbi index d53f690d5..001d46150 100644 --- a/rbi/lib/increase/internal/type/union.rbi +++ b/rbi/lib/increase/internal/type/union.rbi @@ -47,6 +47,9 @@ module Increase sig { params(other: T.anything).returns(T::Boolean) } def ==(other); end + sig { returns(Integer) } + def hash; end + # @api private sig do override diff --git a/rbi/lib/increase/internal/util.rbi b/rbi/lib/increase/internal/util.rbi index 12df0ea84..0ce77413d 100644 --- a/rbi/lib/increase/internal/util.rbi +++ b/rbi/lib/increase/internal/util.rbi @@ -215,6 +215,14 @@ module Increase 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 + + # @api private + # + # Assumes each chunk in stream has `Encoding::BINARY`. sig do params( headers: T.any(T::Hash[String, String], Net::HTTPHeader), @@ -263,12 +271,19 @@ module Increase class << self # @api private + # + # Assumes Strings have been forced into having `Encoding::BINARY`. + # + # 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 # @api private # # https://html.spec.whatwg.org/multipage/server-sent-events.html#parsing-an-event-stream + # + # Assumes that `lines` has been decoded with `#decode_lines`. sig do params(lines: T::Enumerable[String]).returns(T::Enumerable[Increase::Internal::Util::ServerSentEvent]) end diff --git a/rbi/lib/increase/models/account.rbi b/rbi/lib/increase/models/account.rbi index 791082dfa..8be82ee07 100644 --- a/rbi/lib/increase/models/account.rbi +++ b/rbi/lib/increase/models/account.rbi @@ -143,7 +143,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::Account::Bank) } - OrSymbol = T.type_alias { T.any(Symbol, String, Increase::Models::Account::Bank::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # Core Bank CORE_BANK = T.let(:core_bank, Increase::Models::Account::Bank::TaggedSymbol) @@ -164,7 +164,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::Account::Currency) } - OrSymbol = T.type_alias { T.any(Symbol, String, Increase::Models::Account::Currency::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # Canadian Dollar (CAD) CAD = T.let(:CAD, Increase::Models::Account::Currency::TaggedSymbol) @@ -193,7 +193,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::Account::Status) } - OrSymbol = T.type_alias { T.any(Symbol, String, Increase::Models::Account::Status::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # Closed Accounts on which no new activity can occur. CLOSED = T.let(:closed, Increase::Models::Account::Status::TaggedSymbol) @@ -211,7 +211,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::Account::Type) } - OrSymbol = T.type_alias { T.any(Symbol, String, Increase::Models::Account::Type::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } ACCOUNT = T.let(:account, Increase::Models::Account::Type::TaggedSymbol) diff --git a/rbi/lib/increase/models/account_list_params.rbi b/rbi/lib/increase/models/account_list_params.rbi index b3da79fca..74e48e5b6 100644 --- a/rbi/lib/increase/models/account_list_params.rbi +++ b/rbi/lib/increase/models/account_list_params.rbi @@ -170,8 +170,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::AccountListParams::Status::In) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::AccountListParams::Status::In::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # Closed Accounts on which no new activity can occur. CLOSED = T.let(:closed, Increase::Models::AccountListParams::Status::In::TaggedSymbol) diff --git a/rbi/lib/increase/models/account_number.rbi b/rbi/lib/increase/models/account_number.rbi index 8319d94a6..bc217afa6 100644 --- a/rbi/lib/increase/models/account_number.rbi +++ b/rbi/lib/increase/models/account_number.rbi @@ -137,8 +137,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::AccountNumber::InboundACH::DebitStatus) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::AccountNumber::InboundACH::DebitStatus::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # ACH Debits are allowed. ALLOWED = T.let(:allowed, Increase::Models::AccountNumber::InboundACH::DebitStatus::TaggedSymbol) @@ -169,8 +168,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::AccountNumber::InboundChecks::Status) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::AccountNumber::InboundChecks::Status::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # Checks with this Account Number will be processed even if they are not associated with a Check Transfer. ALLOWED = T.let(:allowed, Increase::Models::AccountNumber::InboundChecks::Status::TaggedSymbol) @@ -189,7 +187,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::AccountNumber::Status) } - OrSymbol = T.type_alias { T.any(Symbol, String, Increase::Models::AccountNumber::Status::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # The account number is active. ACTIVE = T.let(:active, Increase::Models::AccountNumber::Status::TaggedSymbol) @@ -210,7 +208,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::AccountNumber::Type) } - OrSymbol = T.type_alias { T.any(Symbol, String, Increase::Models::AccountNumber::Type::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } ACCOUNT_NUMBER = T.let(:account_number, Increase::Models::AccountNumber::Type::TaggedSymbol) diff --git a/rbi/lib/increase/models/account_number_create_params.rbi b/rbi/lib/increase/models/account_number_create_params.rbi index 82ed91665..75c7b6faa 100644 --- a/rbi/lib/increase/models/account_number_create_params.rbi +++ b/rbi/lib/increase/models/account_number_create_params.rbi @@ -93,8 +93,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::AccountNumberCreateParams::InboundACH::DebitStatus) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::AccountNumberCreateParams::InboundACH::DebitStatus::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # ACH Debits are allowed. ALLOWED = @@ -136,8 +135,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::AccountNumberCreateParams::InboundChecks::Status) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::AccountNumberCreateParams::InboundChecks::Status::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # Checks with this Account Number will be processed even if they are not associated with a Check Transfer. ALLOWED = diff --git a/rbi/lib/increase/models/account_number_list_params.rbi b/rbi/lib/increase/models/account_number_list_params.rbi index 8f4b4fcca..b38211a3c 100644 --- a/rbi/lib/increase/models/account_number_list_params.rbi +++ b/rbi/lib/increase/models/account_number_list_params.rbi @@ -129,8 +129,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::AccountNumberListParams::ACHDebitStatus::In) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::AccountNumberListParams::ACHDebitStatus::In::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # ACH Debits are allowed. ALLOWED = T.let(:allowed, Increase::Models::AccountNumberListParams::ACHDebitStatus::In::TaggedSymbol) @@ -207,8 +206,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::AccountNumberListParams::Status::In) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::AccountNumberListParams::Status::In::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # The account number is active. ACTIVE = T.let(:active, Increase::Models::AccountNumberListParams::Status::In::TaggedSymbol) diff --git a/rbi/lib/increase/models/account_number_update_params.rbi b/rbi/lib/increase/models/account_number_update_params.rbi index 4d493d98e..0ad23df6d 100644 --- a/rbi/lib/increase/models/account_number_update_params.rbi +++ b/rbi/lib/increase/models/account_number_update_params.rbi @@ -100,8 +100,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::AccountNumberUpdateParams::InboundACH::DebitStatus) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::AccountNumberUpdateParams::InboundACH::DebitStatus::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # ACH Debits are allowed. ALLOWED = @@ -141,8 +140,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::AccountNumberUpdateParams::InboundChecks::Status) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::AccountNumberUpdateParams::InboundChecks::Status::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # Checks with this Account Number will be processed even if they are not associated with a Check Transfer. ALLOWED = @@ -168,8 +166,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::AccountNumberUpdateParams::Status) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::AccountNumberUpdateParams::Status::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # The account number is active. ACTIVE = T.let(:active, Increase::Models::AccountNumberUpdateParams::Status::TaggedSymbol) diff --git a/rbi/lib/increase/models/account_statement.rbi b/rbi/lib/increase/models/account_statement.rbi index f34d5d42d..dde67a9fc 100644 --- a/rbi/lib/increase/models/account_statement.rbi +++ b/rbi/lib/increase/models/account_statement.rbi @@ -95,7 +95,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::AccountStatement::Type) } - OrSymbol = T.type_alias { T.any(Symbol, String, Increase::Models::AccountStatement::Type::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } ACCOUNT_STATEMENT = T.let(:account_statement, Increase::Models::AccountStatement::Type::TaggedSymbol) diff --git a/rbi/lib/increase/models/account_transfer.rbi b/rbi/lib/increase/models/account_transfer.rbi index 8b8416832..fe1fc3b08 100644 --- a/rbi/lib/increase/models/account_transfer.rbi +++ b/rbi/lib/increase/models/account_transfer.rbi @@ -302,8 +302,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::AccountTransfer::CreatedBy::Category) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::AccountTransfer::CreatedBy::Category::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # An API key. Details will be under the `api_key` object. API_KEY = T.let(:api_key, Increase::Models::AccountTransfer::CreatedBy::Category::TaggedSymbol) @@ -352,8 +351,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::AccountTransfer::Currency) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::AccountTransfer::Currency::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # Canadian Dollar (CAD) CAD = T.let(:CAD, Increase::Models::AccountTransfer::Currency::TaggedSymbol) @@ -382,8 +380,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::AccountTransfer::Network) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::AccountTransfer::Network::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } ACCOUNT = T.let(:account, Increase::Models::AccountTransfer::Network::TaggedSymbol) @@ -396,8 +393,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::AccountTransfer::Status) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::AccountTransfer::Status::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # The transfer is pending approval. PENDING_APPROVAL = T.let(:pending_approval, Increase::Models::AccountTransfer::Status::TaggedSymbol) @@ -418,7 +414,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::AccountTransfer::Type) } - OrSymbol = T.type_alias { T.any(Symbol, String, Increase::Models::AccountTransfer::Type::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } ACCOUNT_TRANSFER = T.let(:account_transfer, Increase::Models::AccountTransfer::Type::TaggedSymbol) diff --git a/rbi/lib/increase/models/ach_prenotification.rbi b/rbi/lib/increase/models/ach_prenotification.rbi index 48dc30b82..964eecb86 100644 --- a/rbi/lib/increase/models/ach_prenotification.rbi +++ b/rbi/lib/increase/models/ach_prenotification.rbi @@ -151,8 +151,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::ACHPrenotification::CreditDebitIndicator) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::ACHPrenotification::CreditDebitIndicator::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # The Prenotification is for an anticipated credit. CREDIT = T.let(:credit, Increase::Models::ACHPrenotification::CreditDebitIndicator::TaggedSymbol) @@ -212,14 +211,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::ACHPrenotification::NotificationsOfChange::ChangeCode) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::ACHPrenotification::NotificationsOfChange::ChangeCode::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # The account number was incorrect. INCORRECT_ACCOUNT_NUMBER = @@ -399,14 +391,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::ACHPrenotification::PrenotificationReturn::ReturnReasonCode) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::ACHPrenotification::PrenotificationReturn::ReturnReasonCode::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # Code R01. Insufficient funds in the receiving account. Sometimes abbreviated to NSF. INSUFFICIENT_FUND = @@ -913,8 +898,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::ACHPrenotification::Status) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::ACHPrenotification::Status::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # The Prenotification is pending submission. PENDING_SUBMITTING = @@ -940,8 +924,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::ACHPrenotification::Type) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::ACHPrenotification::Type::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } ACH_PRENOTIFICATION = T.let(:ach_prenotification, Increase::Models::ACHPrenotification::Type::TaggedSymbol) diff --git a/rbi/lib/increase/models/ach_prenotification_create_params.rbi b/rbi/lib/increase/models/ach_prenotification_create_params.rbi index 549c184b0..462a8d989 100644 --- a/rbi/lib/increase/models/ach_prenotification_create_params.rbi +++ b/rbi/lib/increase/models/ach_prenotification_create_params.rbi @@ -165,14 +165,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::ACHPrenotificationCreateParams::CreditDebitIndicator) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::ACHPrenotificationCreateParams::CreditDebitIndicator::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # The Prenotification is for an anticipated credit. CREDIT = @@ -195,14 +188,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::ACHPrenotificationCreateParams::StandardEntryClassCode) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::ACHPrenotificationCreateParams::StandardEntryClassCode::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # Corporate Credit and Debit (CCD). CORPORATE_CREDIT_OR_DEBIT = diff --git a/rbi/lib/increase/models/ach_transfer.rbi b/rbi/lib/increase/models/ach_transfer.rbi index 45ce99e67..47fd97578 100644 --- a/rbi/lib/increase/models/ach_transfer.rbi +++ b/rbi/lib/increase/models/ach_transfer.rbi @@ -449,8 +449,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::ACHTransfer::Addenda::Category) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::ACHTransfer::Addenda::Category::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # Unstructured `payment_related_information` passed through with the transfer. FREEFORM = T.let(:freeform, Increase::Models::ACHTransfer::Addenda::Category::TaggedSymbol) @@ -667,8 +666,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::ACHTransfer::CreatedBy::Category) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::ACHTransfer::CreatedBy::Category::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # An API key. Details will be under the `api_key` object. API_KEY = T.let(:api_key, Increase::Models::ACHTransfer::CreatedBy::Category::TaggedSymbol) @@ -717,7 +715,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::ACHTransfer::Currency) } - OrSymbol = T.type_alias { T.any(Symbol, String, Increase::Models::ACHTransfer::Currency::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # Canadian Dollar (CAD) CAD = T.let(:CAD, Increase::Models::ACHTransfer::Currency::TaggedSymbol) @@ -747,8 +745,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::ACHTransfer::DestinationAccountHolder) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::ACHTransfer::DestinationAccountHolder::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # The External Account is owned by a business. BUSINESS = T.let(:business, Increase::Models::ACHTransfer::DestinationAccountHolder::TaggedSymbol) @@ -768,7 +765,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::ACHTransfer::Funding) } - OrSymbol = T.type_alias { T.any(Symbol, String, Increase::Models::ACHTransfer::Funding::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # A checking account. CHECKING = T.let(:checking, Increase::Models::ACHTransfer::Funding::TaggedSymbol) @@ -880,8 +877,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::ACHTransfer::InboundFundsHold::Currency) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::ACHTransfer::InboundFundsHold::Currency::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # Canadian Dollar (CAD) CAD = T.let(:CAD, Increase::Models::ACHTransfer::InboundFundsHold::Currency::TaggedSymbol) @@ -910,8 +906,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::ACHTransfer::InboundFundsHold::Status) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::ACHTransfer::InboundFundsHold::Status::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # Funds are still being held. HELD = T.let(:held, Increase::Models::ACHTransfer::InboundFundsHold::Status::TaggedSymbol) @@ -929,8 +924,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::ACHTransfer::InboundFundsHold::Type) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::ACHTransfer::InboundFundsHold::Type::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } INBOUND_FUNDS_HOLD = T.let(:inbound_funds_hold, Increase::Models::ACHTransfer::InboundFundsHold::Type::TaggedSymbol) @@ -945,7 +939,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::ACHTransfer::Network) } - OrSymbol = T.type_alias { T.any(Symbol, String, Increase::Models::ACHTransfer::Network::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } ACH = T.let(:ach, Increase::Models::ACHTransfer::Network::TaggedSymbol) @@ -1001,8 +995,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::ACHTransfer::NotificationsOfChange::ChangeCode) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::ACHTransfer::NotificationsOfChange::ChangeCode::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # The account number was incorrect. INCORRECT_ACCOUNT_NUMBER = @@ -1186,14 +1179,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::ACHTransfer::PreferredEffectiveDate::SettlementSchedule) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::ACHTransfer::PreferredEffectiveDate::SettlementSchedule::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # The chosen effective date will be the same as the ACH processing date on which the transfer is submitted. # This is necessary, but not sufficient for the transfer to be settled same-day: @@ -1290,8 +1276,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::ACHTransfer::Return::ReturnReasonCode) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::ACHTransfer::Return::ReturnReasonCode::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # Code R01. Insufficient funds in the receiving account. Sometimes abbreviated to NSF. INSUFFICIENT_FUND = @@ -1704,8 +1689,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::ACHTransfer::StandardEntryClassCode) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::ACHTransfer::StandardEntryClassCode::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # Corporate Credit and Debit (CCD). CORPORATE_CREDIT_OR_DEBIT = @@ -1735,7 +1719,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::ACHTransfer::Status) } - OrSymbol = T.type_alias { T.any(Symbol, String, Increase::Models::ACHTransfer::Status::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # The transfer is pending approval. PENDING_APPROVAL = T.let(:pending_approval, Increase::Models::ACHTransfer::Status::TaggedSymbol) @@ -1846,8 +1830,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::ACHTransfer::Submission::ExpectedSettlementSchedule) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::ACHTransfer::Submission::ExpectedSettlementSchedule::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # The transfer is expected to settle same-day. SAME_DAY = @@ -1871,7 +1854,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::ACHTransfer::Type) } - OrSymbol = T.type_alias { T.any(Symbol, String, Increase::Models::ACHTransfer::Type::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } ACH_TRANSFER = T.let(:ach_transfer, Increase::Models::ACHTransfer::Type::TaggedSymbol) diff --git a/rbi/lib/increase/models/ach_transfer_create_params.rbi b/rbi/lib/increase/models/ach_transfer_create_params.rbi index 94328790a..9e6f24b50 100644 --- a/rbi/lib/increase/models/ach_transfer_create_params.rbi +++ b/rbi/lib/increase/models/ach_transfer_create_params.rbi @@ -309,8 +309,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::ACHTransferCreateParams::Addenda::Category) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::ACHTransferCreateParams::Addenda::Category::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # Unstructured `payment_related_information` passed through with the transfer. FREEFORM = T.let(:freeform, Increase::Models::ACHTransferCreateParams::Addenda::Category::TaggedSymbol) @@ -418,8 +417,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::ACHTransferCreateParams::DestinationAccountHolder) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::ACHTransferCreateParams::DestinationAccountHolder::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # The External Account is owned by a business. BUSINESS = @@ -445,8 +443,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::ACHTransferCreateParams::Funding) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::ACHTransferCreateParams::Funding::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # A checking account. CHECKING = T.let(:checking, Increase::Models::ACHTransferCreateParams::Funding::TaggedSymbol) @@ -513,14 +510,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::ACHTransferCreateParams::PreferredEffectiveDate::SettlementSchedule) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::ACHTransferCreateParams::PreferredEffectiveDate::SettlementSchedule::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # The chosen effective date will be the same as the ACH processing date on which the transfer is submitted. This is necessary, but not sufficient for the transfer to be settled same-day: it must also be submitted before the last same-day cutoff and be less than or equal to $1,000.000.00. SAME_DAY = @@ -552,8 +542,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::ACHTransferCreateParams::StandardEntryClassCode) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::ACHTransferCreateParams::StandardEntryClassCode::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # Corporate Credit and Debit (CCD). CORPORATE_CREDIT_OR_DEBIT = @@ -595,8 +584,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::ACHTransferCreateParams::TransactionTiming) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::ACHTransferCreateParams::TransactionTiming::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # A Transaction will be created immediately. SYNCHRONOUS = diff --git a/rbi/lib/increase/models/ach_transfer_list_params.rbi b/rbi/lib/increase/models/ach_transfer_list_params.rbi index ddd1fd20c..ca8c47c66 100644 --- a/rbi/lib/increase/models/ach_transfer_list_params.rbi +++ b/rbi/lib/increase/models/ach_transfer_list_params.rbi @@ -164,8 +164,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::ACHTransferListParams::Status::In) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::ACHTransferListParams::Status::In::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # The transfer is pending approval. PENDING_APPROVAL = diff --git a/rbi/lib/increase/models/balance_lookup.rbi b/rbi/lib/increase/models/balance_lookup.rbi index 3f8c48a76..70ab299d6 100644 --- a/rbi/lib/increase/models/balance_lookup.rbi +++ b/rbi/lib/increase/models/balance_lookup.rbi @@ -54,7 +54,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::BalanceLookup::Type) } - OrSymbol = T.type_alias { T.any(Symbol, String, Increase::Models::BalanceLookup::Type::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } BALANCE_LOOKUP = T.let(:balance_lookup, Increase::Models::BalanceLookup::Type::TaggedSymbol) diff --git a/rbi/lib/increase/models/bookkeeping_account.rbi b/rbi/lib/increase/models/bookkeeping_account.rbi index de76f256c..070460e30 100644 --- a/rbi/lib/increase/models/bookkeeping_account.rbi +++ b/rbi/lib/increase/models/bookkeeping_account.rbi @@ -72,8 +72,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::BookkeepingAccount::ComplianceCategory) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::BookkeepingAccount::ComplianceCategory::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # A cash in an commingled Increase Account. COMMINGLED_CASH = @@ -93,8 +92,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::BookkeepingAccount::Type) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::BookkeepingAccount::Type::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } BOOKKEEPING_ACCOUNT = T.let(:bookkeeping_account, Increase::Models::BookkeepingAccount::Type::TaggedSymbol) diff --git a/rbi/lib/increase/models/bookkeeping_account_create_params.rbi b/rbi/lib/increase/models/bookkeeping_account_create_params.rbi index 0cae5a413..148f025cb 100644 --- a/rbi/lib/increase/models/bookkeeping_account_create_params.rbi +++ b/rbi/lib/increase/models/bookkeeping_account_create_params.rbi @@ -68,8 +68,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::BookkeepingAccountCreateParams::ComplianceCategory) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::BookkeepingAccountCreateParams::ComplianceCategory::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # A cash in an commingled Increase Account. COMMINGLED_CASH = diff --git a/rbi/lib/increase/models/bookkeeping_balance_lookup.rbi b/rbi/lib/increase/models/bookkeeping_balance_lookup.rbi index 9e90354f3..9227fb45b 100644 --- a/rbi/lib/increase/models/bookkeeping_balance_lookup.rbi +++ b/rbi/lib/increase/models/bookkeeping_balance_lookup.rbi @@ -47,8 +47,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::BookkeepingBalanceLookup::Type) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::BookkeepingBalanceLookup::Type::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } BOOKKEEPING_BALANCE_LOOKUP = T.let(:bookkeeping_balance_lookup, Increase::Models::BookkeepingBalanceLookup::Type::TaggedSymbol) diff --git a/rbi/lib/increase/models/bookkeeping_entry.rbi b/rbi/lib/increase/models/bookkeeping_entry.rbi index c38285b7e..3832c3793 100644 --- a/rbi/lib/increase/models/bookkeeping_entry.rbi +++ b/rbi/lib/increase/models/bookkeeping_entry.rbi @@ -66,7 +66,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::BookkeepingEntry::Type) } - OrSymbol = T.type_alias { T.any(Symbol, String, Increase::Models::BookkeepingEntry::Type::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } BOOKKEEPING_ENTRY = T.let(:bookkeeping_entry, Increase::Models::BookkeepingEntry::Type::TaggedSymbol) diff --git a/rbi/lib/increase/models/bookkeeping_entry_set.rbi b/rbi/lib/increase/models/bookkeeping_entry_set.rbi index 984422b7c..74b8da931 100644 --- a/rbi/lib/increase/models/bookkeeping_entry_set.rbi +++ b/rbi/lib/increase/models/bookkeeping_entry_set.rbi @@ -94,8 +94,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::BookkeepingEntrySet::Type) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::BookkeepingEntrySet::Type::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } BOOKKEEPING_ENTRY_SET = T.let(:bookkeeping_entry_set, Increase::Models::BookkeepingEntrySet::Type::TaggedSymbol) diff --git a/rbi/lib/increase/models/card.rbi b/rbi/lib/increase/models/card.rbi index cb3da4ed9..e108864cf 100644 --- a/rbi/lib/increase/models/card.rbi +++ b/rbi/lib/increase/models/card.rbi @@ -225,7 +225,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::Card::Status) } - OrSymbol = T.type_alias { T.any(Symbol, String, Increase::Models::Card::Status::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # The card is active. ACTIVE = T.let(:active, Increase::Models::Card::Status::TaggedSymbol) @@ -246,7 +246,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::Card::Type) } - OrSymbol = T.type_alias { T.any(Symbol, String, Increase::Models::Card::Type::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } CARD = T.let(:card, Increase::Models::Card::Type::TaggedSymbol) diff --git a/rbi/lib/increase/models/card_details.rbi b/rbi/lib/increase/models/card_details.rbi index f563b4f07..8b969d98d 100644 --- a/rbi/lib/increase/models/card_details.rbi +++ b/rbi/lib/increase/models/card_details.rbi @@ -73,7 +73,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::CardDetails::Type) } - OrSymbol = T.type_alias { T.any(Symbol, String, Increase::Models::CardDetails::Type::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } CARD_DETAILS = T.let(:card_details, Increase::Models::CardDetails::Type::TaggedSymbol) diff --git a/rbi/lib/increase/models/card_dispute.rbi b/rbi/lib/increase/models/card_dispute.rbi index 7d1402666..41abe8bf6 100644 --- a/rbi/lib/increase/models/card_dispute.rbi +++ b/rbi/lib/increase/models/card_dispute.rbi @@ -229,7 +229,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::CardDispute::Status) } - OrSymbol = T.type_alias { T.any(Symbol, String, Increase::Models::CardDispute::Status::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # The Card Dispute is pending review. PENDING_REVIEWING = T.let(:pending_reviewing, Increase::Models::CardDispute::Status::TaggedSymbol) @@ -260,7 +260,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::CardDispute::Type) } - OrSymbol = T.type_alias { T.any(Symbol, String, Increase::Models::CardDispute::Type::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } CARD_DISPUTE = T.let(:card_dispute, Increase::Models::CardDispute::Type::TaggedSymbol) diff --git a/rbi/lib/increase/models/card_dispute_list_params.rbi b/rbi/lib/increase/models/card_dispute_list_params.rbi index ce749a244..4b51877cf 100644 --- a/rbi/lib/increase/models/card_dispute_list_params.rbi +++ b/rbi/lib/increase/models/card_dispute_list_params.rbi @@ -147,8 +147,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::CardDisputeListParams::Status::In) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::CardDisputeListParams::Status::In::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # The Card Dispute is pending review. PENDING_REVIEWING = diff --git a/rbi/lib/increase/models/card_list_params.rbi b/rbi/lib/increase/models/card_list_params.rbi index 1e7e17dbf..24f469e37 100644 --- a/rbi/lib/increase/models/card_list_params.rbi +++ b/rbi/lib/increase/models/card_list_params.rbi @@ -148,8 +148,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::CardListParams::Status::In) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::CardListParams::Status::In::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # The card is active. ACTIVE = T.let(:active, Increase::Models::CardListParams::Status::In::TaggedSymbol) diff --git a/rbi/lib/increase/models/card_payment.rbi b/rbi/lib/increase/models/card_payment.rbi index daa801334..85a5a3f5b 100644 --- a/rbi/lib/increase/models/card_payment.rbi +++ b/rbi/lib/increase/models/card_payment.rbi @@ -482,8 +482,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::CardPayment::Element::CardAuthentication::Category) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::CardPayment::Element::CardAuthentication::Category::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # The authentication attempt is for a payment. PAYMENT_AUTHENTICATION = @@ -606,14 +605,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::CardPayment::Element::CardAuthentication::Challenge::Attempt::Outcome) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::CardPayment::Element::CardAuthentication::Challenge::Attempt::Outcome::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # The attempt was successful. SUCCESSFUL = @@ -645,14 +637,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::CardPayment::Element::CardAuthentication::Challenge::VerificationMethod) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::CardPayment::Element::CardAuthentication::Challenge::VerificationMethod::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # The one-time code was sent via text message. TEXT_MESSAGE = @@ -691,14 +676,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::CardPayment::Element::CardAuthentication::DenyReason) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::CardPayment::Element::CardAuthentication::DenyReason::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # The group was locked. GROUP_LOCKED = @@ -752,14 +730,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::CardPayment::Element::CardAuthentication::DeviceChannel) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::CardPayment::Element::CardAuthentication::DeviceChannel::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # The authentication attempt was made from an app. APP = @@ -789,8 +760,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::CardPayment::Element::CardAuthentication::Status) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::CardPayment::Element::CardAuthentication::Status::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # The authentication attempt was denied. DENIED = T.let(:denied, Increase::Models::CardPayment::Element::CardAuthentication::Status::TaggedSymbol) @@ -859,8 +829,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::CardPayment::Element::CardAuthentication::Type) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::CardPayment::Element::CardAuthentication::Type::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } CARD_AUTHENTICATION = T.let( @@ -1148,8 +1117,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::CardPayment::Element::CardAuthorization::Actioner) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::CardPayment::Element::CardAuthorization::Actioner::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # This object was actioned by the user through a real-time decision. USER = T.let(:user, Increase::Models::CardPayment::Element::CardAuthorization::Actioner::TaggedSymbol) @@ -1176,8 +1144,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::CardPayment::Element::CardAuthorization::Currency) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::CardPayment::Element::CardAuthorization::Currency::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # Canadian Dollar (CAD) CAD = T.let(:CAD, Increase::Models::CardPayment::Element::CardAuthorization::Currency::TaggedSymbol) @@ -1211,8 +1178,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::CardPayment::Element::CardAuthorization::Direction) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::CardPayment::Element::CardAuthorization::Direction::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # A regular card authorization where funds are debited from the cardholder. SETTLEMENT = @@ -1283,14 +1249,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::CardPayment::Element::CardAuthorization::NetworkDetails::Category) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::CardPayment::Element::CardAuthorization::NetworkDetails::Category::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # Visa VISA = @@ -1393,14 +1352,7 @@ module Increase T.type_alias do T.all(Symbol, Increase::Models::CardPayment::Element::CardAuthorization::NetworkDetails::Visa::ElectronicCommerceIndicator) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::CardPayment::Element::CardAuthorization::NetworkDetails::Visa::ElectronicCommerceIndicator::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # Single transaction of a mail/phone order: Use to indicate that the transaction is a mail/phone order purchase, not a recurring transaction or installment payment. For domestic transactions in the US region, this value may also indicate one bill payment transaction in the card-present or card-absent environments. MAIL_PHONE_ORDER = @@ -1478,14 +1430,7 @@ module Increase T.type_alias do T.all(Symbol, Increase::Models::CardPayment::Element::CardAuthorization::NetworkDetails::Visa::PointOfServiceEntryMode) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::CardPayment::Element::CardAuthorization::NetworkDetails::Visa::PointOfServiceEntryMode::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # Unknown UNKNOWN = @@ -1577,14 +1522,7 @@ module Increase T.type_alias do T.all(Symbol, Increase::Models::CardPayment::Element::CardAuthorization::NetworkDetails::Visa::StandInProcessingReason) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::CardPayment::Element::CardAuthorization::NetworkDetails::Visa::StandInProcessingReason::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # Increase failed to process the authorization in a timely manner. ISSUER_ERROR = @@ -1696,14 +1634,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::CardPayment::Element::CardAuthorization::ProcessingCategory) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::CardPayment::Element::CardAuthorization::ProcessingCategory::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # Account funding transactions are transactions used to e.g., fund an account or transfer funds between accounts. ACCOUNT_FUNDING = @@ -1763,8 +1694,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::CardPayment::Element::CardAuthorization::Type) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::CardPayment::Element::CardAuthorization::Type::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } CARD_AUTHORIZATION = T.let(:card_authorization, Increase::Models::CardPayment::Element::CardAuthorization::Type::TaggedSymbol) @@ -1870,14 +1800,7 @@ module Increase T.type_alias do T.all(Symbol, Increase::Models::CardPayment::Element::CardAuthorization::Verification::CardVerificationCode::Result) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::CardPayment::Element::CardAuthorization::Verification::CardVerificationCode::Result::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # No card verification code was provided in the authorization request. NOT_CHECKED = @@ -1981,14 +1904,7 @@ module Increase T.type_alias do T.all(Symbol, Increase::Models::CardPayment::Element::CardAuthorization::Verification::CardholderAddress::Result) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::CardPayment::Element::CardAuthorization::Verification::CardholderAddress::Result::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # No address was provided in the authorization request. NOT_CHECKED = @@ -2113,14 +2029,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::CardPayment::Element::CardAuthorizationExpiration::Currency) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::CardPayment::Element::CardAuthorizationExpiration::Currency::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # Canadian Dollar (CAD) CAD = @@ -2161,14 +2070,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::CardPayment::Element::CardAuthorizationExpiration::Network) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::CardPayment::Element::CardAuthorizationExpiration::Network::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # Visa VISA = @@ -2190,14 +2092,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::CardPayment::Element::CardAuthorizationExpiration::Type) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::CardPayment::Element::CardAuthorizationExpiration::Type::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } CARD_AUTHORIZATION_EXPIRATION = T.let( @@ -2477,8 +2372,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::CardPayment::Element::CardDecline::Actioner) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::CardPayment::Element::CardDecline::Actioner::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # This object was actioned by the user through a real-time decision. USER = T.let(:user, Increase::Models::CardPayment::Element::CardDecline::Actioner::TaggedSymbol) @@ -2500,8 +2394,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::CardPayment::Element::CardDecline::Currency) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::CardPayment::Element::CardDecline::Currency::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # Canadian Dollar (CAD) CAD = T.let(:CAD, Increase::Models::CardPayment::Element::CardDecline::Currency::TaggedSymbol) @@ -2532,8 +2425,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::CardPayment::Element::CardDecline::Direction) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::CardPayment::Element::CardDecline::Direction::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # A regular card authorization where funds are debited from the cardholder. SETTLEMENT = @@ -2600,14 +2492,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::CardPayment::Element::CardDecline::NetworkDetails::Category) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::CardPayment::Element::CardDecline::NetworkDetails::Category::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # Visa VISA = @@ -2707,14 +2592,7 @@ module Increase T.type_alias do T.all(Symbol, Increase::Models::CardPayment::Element::CardDecline::NetworkDetails::Visa::ElectronicCommerceIndicator) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::CardPayment::Element::CardDecline::NetworkDetails::Visa::ElectronicCommerceIndicator::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # Single transaction of a mail/phone order: Use to indicate that the transaction is a mail/phone order purchase, not a recurring transaction or installment payment. For domestic transactions in the US region, this value may also indicate one bill payment transaction in the card-present or card-absent environments. MAIL_PHONE_ORDER = @@ -2792,14 +2670,7 @@ module Increase T.type_alias do T.all(Symbol, Increase::Models::CardPayment::Element::CardDecline::NetworkDetails::Visa::PointOfServiceEntryMode) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::CardPayment::Element::CardDecline::NetworkDetails::Visa::PointOfServiceEntryMode::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # Unknown UNKNOWN = @@ -2891,14 +2762,7 @@ module Increase T.type_alias do T.all(Symbol, Increase::Models::CardPayment::Element::CardDecline::NetworkDetails::Visa::StandInProcessingReason) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::CardPayment::Element::CardDecline::NetworkDetails::Visa::StandInProcessingReason::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # Increase failed to process the authorization in a timely manner. ISSUER_ERROR = @@ -3010,14 +2874,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::CardPayment::Element::CardDecline::ProcessingCategory) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::CardPayment::Element::CardDecline::ProcessingCategory::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # Account funding transactions are transactions used to e.g., fund an account or transfer funds between accounts. ACCOUNT_FUNDING = @@ -3066,14 +2923,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::CardPayment::Element::CardDecline::RealTimeDecisionReason) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::CardPayment::Element::CardDecline::RealTimeDecisionReason::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # The cardholder does not have sufficient funds to cover the transaction. The merchant may attempt to process the transaction again. INSUFFICIENT_FUNDS = @@ -3129,8 +2979,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::CardPayment::Element::CardDecline::Reason) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::CardPayment::Element::CardDecline::Reason::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # The account has been closed. ACCOUNT_CLOSED = @@ -3208,6 +3057,13 @@ module Increase Increase::Models::CardPayment::Element::CardDecline::Reason::TaggedSymbol ) + # The transaction was declined because the 3DS authentication failed. + FAILED_3DS_AUTHENTICATION = + T.let( + :failed_3ds_authentication, + Increase::Models::CardPayment::Element::CardDecline::Reason::TaggedSymbol + ) + # The transaction was suspected to be fraudulent. Please reach out to support@increase.com for more information. SUSPECTED_FRAUD = T.let(:suspected_fraud, Increase::Models::CardPayment::Element::CardDecline::Reason::TaggedSymbol) @@ -3313,14 +3169,7 @@ module Increase T.type_alias do T.all(Symbol, Increase::Models::CardPayment::Element::CardDecline::Verification::CardVerificationCode::Result) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::CardPayment::Element::CardDecline::Verification::CardVerificationCode::Result::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # No card verification code was provided in the authorization request. NOT_CHECKED = @@ -3424,14 +3273,7 @@ module Increase T.type_alias do T.all(Symbol, Increase::Models::CardPayment::Element::CardDecline::Verification::CardholderAddress::Result) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::CardPayment::Element::CardDecline::Verification::CardholderAddress::Result::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # No address was provided in the authorization request. NOT_CHECKED = @@ -3589,14 +3431,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::CardPayment::Element::CardFuelConfirmation::Currency) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::CardPayment::Element::CardFuelConfirmation::Currency::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # Canadian Dollar (CAD) CAD = T.let(:CAD, Increase::Models::CardPayment::Element::CardFuelConfirmation::Currency::TaggedSymbol) @@ -3629,8 +3464,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::CardPayment::Element::CardFuelConfirmation::Network) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::CardPayment::Element::CardFuelConfirmation::Network::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # Visa VISA = T.let(:visa, Increase::Models::CardPayment::Element::CardFuelConfirmation::Network::TaggedSymbol) @@ -3690,8 +3524,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::CardPayment::Element::CardFuelConfirmation::Type) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::CardPayment::Element::CardFuelConfirmation::Type::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } CARD_FUEL_CONFIRMATION = T.let( @@ -3839,8 +3672,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::CardPayment::Element::CardIncrement::Actioner) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::CardPayment::Element::CardIncrement::Actioner::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # This object was actioned by the user through a real-time decision. USER = T.let(:user, Increase::Models::CardPayment::Element::CardIncrement::Actioner::TaggedSymbol) @@ -3863,8 +3695,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::CardPayment::Element::CardIncrement::Currency) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::CardPayment::Element::CardIncrement::Currency::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # Canadian Dollar (CAD) CAD = T.let(:CAD, Increase::Models::CardPayment::Element::CardIncrement::Currency::TaggedSymbol) @@ -3894,8 +3725,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::CardPayment::Element::CardIncrement::Network) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::CardPayment::Element::CardIncrement::Network::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # Visa VISA = T.let(:visa, Increase::Models::CardPayment::Element::CardIncrement::Network::TaggedSymbol) @@ -3952,8 +3782,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::CardPayment::Element::CardIncrement::Type) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::CardPayment::Element::CardIncrement::Type::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } CARD_INCREMENT = T.let(:card_increment, Increase::Models::CardPayment::Element::CardIncrement::Type::TaggedSymbol) @@ -4208,14 +4037,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::CardPayment::Element::CardRefund::Cashback::Currency) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::CardPayment::Element::CardRefund::Cashback::Currency::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # Canadian Dollar (CAD) CAD = T.let(:CAD, Increase::Models::CardPayment::Element::CardRefund::Cashback::Currency::TaggedSymbol) @@ -4250,8 +4072,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::CardPayment::Element::CardRefund::Currency) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::CardPayment::Element::CardRefund::Currency::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # Canadian Dollar (CAD) CAD = T.let(:CAD, Increase::Models::CardPayment::Element::CardRefund::Currency::TaggedSymbol) @@ -4322,14 +4143,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::CardPayment::Element::CardRefund::Interchange::Currency) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::CardPayment::Element::CardRefund::Interchange::Currency::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # Canadian Dollar (CAD) CAD = @@ -4723,14 +4537,7 @@ module Increase T.type_alias do T.all(Symbol, Increase::Models::CardPayment::Element::CardRefund::PurchaseDetails::CarRental::ExtraCharges) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::CardPayment::Element::CardRefund::PurchaseDetails::CarRental::ExtraCharges::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # No extra charge NO_EXTRA_CHARGE = @@ -4792,14 +4599,7 @@ module Increase T.type_alias do T.all(Symbol, Increase::Models::CardPayment::Element::CardRefund::PurchaseDetails::CarRental::NoShowIndicator) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::CardPayment::Element::CardRefund::PurchaseDetails::CarRental::NoShowIndicator::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # Not applicable NOT_APPLICABLE = @@ -4990,14 +4790,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::CardPayment::Element::CardRefund::PurchaseDetails::Lodging::ExtraCharges) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::CardPayment::Element::CardRefund::PurchaseDetails::Lodging::ExtraCharges::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # No extra charge NO_EXTRA_CHARGE = @@ -5066,14 +4859,7 @@ module Increase T.type_alias do T.all(Symbol, Increase::Models::CardPayment::Element::CardRefund::PurchaseDetails::Lodging::NoShowIndicator) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::CardPayment::Element::CardRefund::PurchaseDetails::Lodging::NoShowIndicator::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # Not applicable NOT_APPLICABLE = @@ -5109,14 +4895,7 @@ module Increase T.type_alias do T.all(Symbol, Increase::Models::CardPayment::Element::CardRefund::PurchaseDetails::PurchaseIdentifierFormat) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::CardPayment::Element::CardRefund::PurchaseDetails::PurchaseIdentifierFormat::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # Free text FREE_TEXT = @@ -5407,14 +5186,7 @@ module Increase T.type_alias do T.all(Symbol, Increase::Models::CardPayment::Element::CardRefund::PurchaseDetails::Travel::Ancillary::CreditReasonIndicator) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::CardPayment::Element::CardRefund::PurchaseDetails::Travel::Ancillary::CreditReasonIndicator::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # No credit NO_CREDIT = @@ -5502,14 +5274,7 @@ module Increase T.type_alias do T.all(Symbol, Increase::Models::CardPayment::Element::CardRefund::PurchaseDetails::Travel::Ancillary::Service::Category) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::CardPayment::Element::CardRefund::PurchaseDetails::Travel::Ancillary::Service::Category::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # None NONE = @@ -5700,14 +5465,7 @@ module Increase T.type_alias do T.all(Symbol, Increase::Models::CardPayment::Element::CardRefund::PurchaseDetails::Travel::CreditReasonIndicator) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::CardPayment::Element::CardRefund::PurchaseDetails::Travel::CreditReasonIndicator::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # No credit NO_CREDIT = @@ -5770,14 +5528,7 @@ module Increase T.type_alias do T.all(Symbol, Increase::Models::CardPayment::Element::CardRefund::PurchaseDetails::Travel::RestrictedTicketIndicator) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::CardPayment::Element::CardRefund::PurchaseDetails::Travel::RestrictedTicketIndicator::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # No restrictions NO_RESTRICTIONS = @@ -5812,14 +5563,7 @@ module Increase T.type_alias do T.all(Symbol, Increase::Models::CardPayment::Element::CardRefund::PurchaseDetails::Travel::TicketChangeIndicator) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::CardPayment::Element::CardRefund::PurchaseDetails::Travel::TicketChangeIndicator::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # None NONE = @@ -5930,14 +5674,7 @@ module Increase T.type_alias do T.all(Symbol, Increase::Models::CardPayment::Element::CardRefund::PurchaseDetails::Travel::TripLeg::StopOverCode) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::CardPayment::Element::CardRefund::PurchaseDetails::Travel::TripLeg::StopOverCode::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # None NONE = @@ -5980,8 +5717,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::CardPayment::Element::CardRefund::Type) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::CardPayment::Element::CardRefund::Type::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } CARD_REFUND = T.let(:card_refund, Increase::Models::CardPayment::Element::CardRefund::Type::TaggedSymbol) @@ -6165,8 +5901,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::CardPayment::Element::CardReversal::Currency) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::CardPayment::Element::CardReversal::Currency::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # Canadian Dollar (CAD) CAD = T.let(:CAD, Increase::Models::CardPayment::Element::CardReversal::Currency::TaggedSymbol) @@ -6196,8 +5931,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::CardPayment::Element::CardReversal::Network) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::CardPayment::Element::CardReversal::Network::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # Visa VISA = T.let(:visa, Increase::Models::CardPayment::Element::CardReversal::Network::TaggedSymbol) @@ -6253,8 +5987,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::CardPayment::Element::CardReversal::ReversalReason) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::CardPayment::Element::CardReversal::ReversalReason::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # The Card Reversal was initiated at the customer's request. REVERSED_BY_CUSTOMER = @@ -6297,8 +6030,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::CardPayment::Element::CardReversal::Type) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::CardPayment::Element::CardReversal::Type::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } CARD_REVERSAL = T.let(:card_reversal, Increase::Models::CardPayment::Element::CardReversal::Type::TaggedSymbol) @@ -6580,14 +6312,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::CardPayment::Element::CardSettlement::Cashback::Currency) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::CardPayment::Element::CardSettlement::Cashback::Currency::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # Canadian Dollar (CAD) CAD = @@ -6630,8 +6355,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::CardPayment::Element::CardSettlement::Currency) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::CardPayment::Element::CardSettlement::Currency::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # Canadian Dollar (CAD) CAD = T.let(:CAD, Increase::Models::CardPayment::Element::CardSettlement::Currency::TaggedSymbol) @@ -6702,14 +6426,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::CardPayment::Element::CardSettlement::Interchange::Currency) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::CardPayment::Element::CardSettlement::Interchange::Currency::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # Canadian Dollar (CAD) CAD = @@ -7105,14 +6822,7 @@ module Increase T.type_alias do T.all(Symbol, Increase::Models::CardPayment::Element::CardSettlement::PurchaseDetails::CarRental::ExtraCharges) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::CardPayment::Element::CardSettlement::PurchaseDetails::CarRental::ExtraCharges::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # No extra charge NO_EXTRA_CHARGE = @@ -7176,14 +6886,7 @@ module Increase T.type_alias do T.all(Symbol, Increase::Models::CardPayment::Element::CardSettlement::PurchaseDetails::CarRental::NoShowIndicator) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::CardPayment::Element::CardSettlement::PurchaseDetails::CarRental::NoShowIndicator::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # Not applicable NOT_APPLICABLE = @@ -7376,14 +7079,7 @@ module Increase T.type_alias do T.all(Symbol, Increase::Models::CardPayment::Element::CardSettlement::PurchaseDetails::Lodging::ExtraCharges) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::CardPayment::Element::CardSettlement::PurchaseDetails::Lodging::ExtraCharges::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # No extra charge NO_EXTRA_CHARGE = @@ -7454,14 +7150,7 @@ module Increase T.type_alias do T.all(Symbol, Increase::Models::CardPayment::Element::CardSettlement::PurchaseDetails::Lodging::NoShowIndicator) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::CardPayment::Element::CardSettlement::PurchaseDetails::Lodging::NoShowIndicator::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # Not applicable NOT_APPLICABLE = @@ -7497,14 +7186,7 @@ module Increase T.type_alias do T.all(Symbol, Increase::Models::CardPayment::Element::CardSettlement::PurchaseDetails::PurchaseIdentifierFormat) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::CardPayment::Element::CardSettlement::PurchaseDetails::PurchaseIdentifierFormat::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # Free text FREE_TEXT = @@ -7803,14 +7485,7 @@ module Increase T.type_alias do T.all(Symbol, Increase::Models::CardPayment::Element::CardSettlement::PurchaseDetails::Travel::Ancillary::CreditReasonIndicator) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::CardPayment::Element::CardSettlement::PurchaseDetails::Travel::Ancillary::CreditReasonIndicator::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # No credit NO_CREDIT = @@ -7898,14 +7573,7 @@ module Increase T.type_alias do T.all(Symbol, Increase::Models::CardPayment::Element::CardSettlement::PurchaseDetails::Travel::Ancillary::Service::Category) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::CardPayment::Element::CardSettlement::PurchaseDetails::Travel::Ancillary::Service::Category::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # None NONE = @@ -8096,14 +7764,7 @@ module Increase T.type_alias do T.all(Symbol, Increase::Models::CardPayment::Element::CardSettlement::PurchaseDetails::Travel::CreditReasonIndicator) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::CardPayment::Element::CardSettlement::PurchaseDetails::Travel::CreditReasonIndicator::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # No credit NO_CREDIT = @@ -8166,14 +7827,7 @@ module Increase T.type_alias do T.all(Symbol, Increase::Models::CardPayment::Element::CardSettlement::PurchaseDetails::Travel::RestrictedTicketIndicator) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::CardPayment::Element::CardSettlement::PurchaseDetails::Travel::RestrictedTicketIndicator::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # No restrictions NO_RESTRICTIONS = @@ -8208,14 +7862,7 @@ module Increase T.type_alias do T.all(Symbol, Increase::Models::CardPayment::Element::CardSettlement::PurchaseDetails::Travel::TicketChangeIndicator) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::CardPayment::Element::CardSettlement::PurchaseDetails::Travel::TicketChangeIndicator::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # None NONE = @@ -8326,14 +7973,7 @@ module Increase T.type_alias do T.all(Symbol, Increase::Models::CardPayment::Element::CardSettlement::PurchaseDetails::Travel::TripLeg::StopOverCode) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::CardPayment::Element::CardSettlement::PurchaseDetails::Travel::TripLeg::StopOverCode::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # None NONE = @@ -8377,8 +8017,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::CardPayment::Element::CardSettlement::Type) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::CardPayment::Element::CardSettlement::Type::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } CARD_SETTLEMENT = T.let(:card_settlement, Increase::Models::CardPayment::Element::CardSettlement::Type::TaggedSymbol) @@ -8597,8 +8236,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::CardPayment::Element::CardValidation::Actioner) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::CardPayment::Element::CardValidation::Actioner::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # This object was actioned by the user through a real-time decision. USER = T.let(:user, Increase::Models::CardPayment::Element::CardValidation::Actioner::TaggedSymbol) @@ -8621,8 +8259,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::CardPayment::Element::CardValidation::Currency) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::CardPayment::Element::CardValidation::Currency::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # Canadian Dollar (CAD) CAD = T.let(:CAD, Increase::Models::CardPayment::Element::CardValidation::Currency::TaggedSymbol) @@ -8700,14 +8337,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::CardPayment::Element::CardValidation::NetworkDetails::Category) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::CardPayment::Element::CardValidation::NetworkDetails::Category::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # Visa VISA = @@ -8810,14 +8440,7 @@ module Increase T.type_alias do T.all(Symbol, Increase::Models::CardPayment::Element::CardValidation::NetworkDetails::Visa::ElectronicCommerceIndicator) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::CardPayment::Element::CardValidation::NetworkDetails::Visa::ElectronicCommerceIndicator::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # Single transaction of a mail/phone order: Use to indicate that the transaction is a mail/phone order purchase, not a recurring transaction or installment payment. For domestic transactions in the US region, this value may also indicate one bill payment transaction in the card-present or card-absent environments. MAIL_PHONE_ORDER = @@ -8895,14 +8518,7 @@ module Increase T.type_alias do T.all(Symbol, Increase::Models::CardPayment::Element::CardValidation::NetworkDetails::Visa::PointOfServiceEntryMode) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::CardPayment::Element::CardValidation::NetworkDetails::Visa::PointOfServiceEntryMode::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # Unknown UNKNOWN = @@ -8994,14 +8610,7 @@ module Increase T.type_alias do T.all(Symbol, Increase::Models::CardPayment::Element::CardValidation::NetworkDetails::Visa::StandInProcessingReason) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::CardPayment::Element::CardValidation::NetworkDetails::Visa::StandInProcessingReason::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # Increase failed to process the authorization in a timely manner. ISSUER_ERROR = @@ -9113,8 +8722,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::CardPayment::Element::CardValidation::Type) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::CardPayment::Element::CardValidation::Type::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } CARD_VALIDATION = T.let(:card_validation, Increase::Models::CardPayment::Element::CardValidation::Type::TaggedSymbol) @@ -9220,14 +8828,7 @@ module Increase T.type_alias do T.all(Symbol, Increase::Models::CardPayment::Element::CardValidation::Verification::CardVerificationCode::Result) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::CardPayment::Element::CardValidation::Verification::CardVerificationCode::Result::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # No card verification code was provided in the authorization request. NOT_CHECKED = @@ -9331,14 +8932,7 @@ module Increase T.type_alias do T.all(Symbol, Increase::Models::CardPayment::Element::CardValidation::Verification::CardholderAddress::Result) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::CardPayment::Element::CardValidation::Verification::CardholderAddress::Result::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # No address was provided in the authorization request. NOT_CHECKED = @@ -9402,8 +8996,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::CardPayment::Element::Category) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::CardPayment::Element::Category::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # Card Authorization: details will be under the `card_authorization` object. CARD_AUTHORIZATION = @@ -9514,7 +9107,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::CardPayment::Type) } - OrSymbol = T.type_alias { T.any(Symbol, String, Increase::Models::CardPayment::Type::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } CARD_PAYMENT = T.let(:card_payment, Increase::Models::CardPayment::Type::TaggedSymbol) diff --git a/rbi/lib/increase/models/card_purchase_supplement.rbi b/rbi/lib/increase/models/card_purchase_supplement.rbi index 71cf7e469..83d90c2c4 100644 --- a/rbi/lib/increase/models/card_purchase_supplement.rbi +++ b/rbi/lib/increase/models/card_purchase_supplement.rbi @@ -206,14 +206,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::CardPurchaseSupplement::Invoice::DiscountTreatmentCode) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::CardPurchaseSupplement::Invoice::DiscountTreatmentCode::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # No invoice level discount provided NO_INVOICE_LEVEL_DISCOUNT_PROVIDED = @@ -249,8 +242,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::CardPurchaseSupplement::Invoice::TaxTreatments) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::CardPurchaseSupplement::Invoice::TaxTreatments::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # No tax applies NO_TAX_APPLIES = @@ -437,8 +429,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::CardPurchaseSupplement::LineItem::DetailIndicator) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::CardPurchaseSupplement::LineItem::DetailIndicator::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # Normal NORMAL = @@ -465,14 +456,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::CardPurchaseSupplement::LineItem::DiscountTreatmentCode) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::CardPurchaseSupplement::LineItem::DiscountTreatmentCode::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # No line item level discount provided NO_LINE_ITEM_LEVEL_DISCOUNT_PROVIDED = @@ -509,8 +493,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::CardPurchaseSupplement::Type) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::CardPurchaseSupplement::Type::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } CARD_PURCHASE_SUPPLEMENT = T.let(:card_purchase_supplement, Increase::Models::CardPurchaseSupplement::Type::TaggedSymbol) diff --git a/rbi/lib/increase/models/card_update_params.rbi b/rbi/lib/increase/models/card_update_params.rbi index 2a80fe72e..c56585641 100644 --- a/rbi/lib/increase/models/card_update_params.rbi +++ b/rbi/lib/increase/models/card_update_params.rbi @@ -166,8 +166,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::CardUpdateParams::Status) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::CardUpdateParams::Status::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # The card is active. ACTIVE = T.let(:active, Increase::Models::CardUpdateParams::Status::TaggedSymbol) diff --git a/rbi/lib/increase/models/check_deposit.rbi b/rbi/lib/increase/models/check_deposit.rbi index 9f80e9a92..84452181f 100644 --- a/rbi/lib/increase/models/check_deposit.rbi +++ b/rbi/lib/increase/models/check_deposit.rbi @@ -278,8 +278,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::CheckDeposit::DepositAcceptance::Currency) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::CheckDeposit::DepositAcceptance::Currency::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # Canadian Dollar (CAD) CAD = T.let(:CAD, Increase::Models::CheckDeposit::DepositAcceptance::Currency::TaggedSymbol) @@ -369,8 +368,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::CheckDeposit::DepositRejection::Currency) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::CheckDeposit::DepositRejection::Currency::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # Canadian Dollar (CAD) CAD = T.let(:CAD, Increase::Models::CheckDeposit::DepositRejection::Currency::TaggedSymbol) @@ -399,8 +397,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::CheckDeposit::DepositRejection::Reason) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::CheckDeposit::DepositRejection::Reason::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # The check's image is incomplete. INCOMPLETE_IMAGE = @@ -521,8 +518,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::CheckDeposit::DepositReturn::Currency) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::CheckDeposit::DepositReturn::Currency::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # Canadian Dollar (CAD) CAD = T.let(:CAD, Increase::Models::CheckDeposit::DepositReturn::Currency::TaggedSymbol) @@ -553,8 +549,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::CheckDeposit::DepositReturn::ReturnReason) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::CheckDeposit::DepositReturn::ReturnReason::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # The check doesn't allow ACH conversion. ACH_CONVERSION_NOT_SUPPORTED = @@ -808,8 +803,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::CheckDeposit::InboundFundsHold::Currency) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::CheckDeposit::InboundFundsHold::Currency::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # Canadian Dollar (CAD) CAD = T.let(:CAD, Increase::Models::CheckDeposit::InboundFundsHold::Currency::TaggedSymbol) @@ -838,8 +832,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::CheckDeposit::InboundFundsHold::Status) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::CheckDeposit::InboundFundsHold::Status::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # Funds are still being held. HELD = T.let(:held, Increase::Models::CheckDeposit::InboundFundsHold::Status::TaggedSymbol) @@ -857,8 +850,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::CheckDeposit::InboundFundsHold::Type) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::CheckDeposit::InboundFundsHold::Type::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } INBOUND_FUNDS_HOLD = T.let(:inbound_funds_hold, Increase::Models::CheckDeposit::InboundFundsHold::Type::TaggedSymbol) @@ -873,7 +865,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::CheckDeposit::Status) } - OrSymbol = T.type_alias { T.any(Symbol, String, Increase::Models::CheckDeposit::Status::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # The Check Deposit is pending review. PENDING = T.let(:pending, Increase::Models::CheckDeposit::Status::TaggedSymbol) @@ -897,7 +889,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::CheckDeposit::Type) } - OrSymbol = T.type_alias { T.any(Symbol, String, Increase::Models::CheckDeposit::Type::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } CHECK_DEPOSIT = T.let(:check_deposit, Increase::Models::CheckDeposit::Type::TaggedSymbol) diff --git a/rbi/lib/increase/models/check_transfer.rbi b/rbi/lib/increase/models/check_transfer.rbi index 92f925e8b..52866d031 100644 --- a/rbi/lib/increase/models/check_transfer.rbi +++ b/rbi/lib/increase/models/check_transfer.rbi @@ -386,8 +386,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::CheckTransfer::CreatedBy::Category) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::CheckTransfer::CreatedBy::Category::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # An API key. Details will be under the `api_key` object. API_KEY = T.let(:api_key, Increase::Models::CheckTransfer::CreatedBy::Category::TaggedSymbol) @@ -436,8 +435,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::CheckTransfer::Currency) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::CheckTransfer::Currency::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # Canadian Dollar (CAD) CAD = T.let(:CAD, Increase::Models::CheckTransfer::Currency::TaggedSymbol) @@ -466,8 +464,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::CheckTransfer::FulfillmentMethod) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::CheckTransfer::FulfillmentMethod::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # Increase will print and mail a physical check. PHYSICAL_CHECK = T.let(:physical_check, Increase::Models::CheckTransfer::FulfillmentMethod::TaggedSymbol) @@ -727,8 +724,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::CheckTransfer::PhysicalCheck::ShippingMethod) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::CheckTransfer::PhysicalCheck::ShippingMethod::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # USPS First Class USPS_FIRST_CLASS = @@ -784,14 +780,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::CheckTransfer::PhysicalCheck::TrackingUpdate::Category) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::CheckTransfer::PhysicalCheck::TrackingUpdate::Category::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # The check is in transit. IN_TRANSIT = @@ -829,7 +818,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::CheckTransfer::Status) } - OrSymbol = T.type_alias { T.any(Symbol, String, Increase::Models::CheckTransfer::Status::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # The transfer is awaiting approval. PENDING_APPROVAL = T.let(:pending_approval, Increase::Models::CheckTransfer::Status::TaggedSymbol) @@ -915,8 +904,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::CheckTransfer::StopPaymentRequest::Reason) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::CheckTransfer::StopPaymentRequest::Reason::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # The check could not be delivered. MAIL_DELIVERY_FAILED = @@ -943,8 +931,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::CheckTransfer::StopPaymentRequest::Type) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::CheckTransfer::StopPaymentRequest::Type::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } CHECK_TRANSFER_STOP_PAYMENT_REQUEST = T.let( @@ -1014,8 +1001,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::CheckTransfer::Submission::AddressCorrectionAction) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::CheckTransfer::Submission::AddressCorrectionAction::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # No address correction took place. NONE = T.let(:none, Increase::Models::CheckTransfer::Submission::AddressCorrectionAction::TaggedSymbol) @@ -1121,7 +1107,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::CheckTransfer::Type) } - OrSymbol = T.type_alias { T.any(Symbol, String, Increase::Models::CheckTransfer::Type::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } CHECK_TRANSFER = T.let(:check_transfer, Increase::Models::CheckTransfer::Type::TaggedSymbol) diff --git a/rbi/lib/increase/models/check_transfer_create_params.rbi b/rbi/lib/increase/models/check_transfer_create_params.rbi index ace4e9c36..1c7f0fcea 100644 --- a/rbi/lib/increase/models/check_transfer_create_params.rbi +++ b/rbi/lib/increase/models/check_transfer_create_params.rbi @@ -104,8 +104,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::CheckTransferCreateParams::FulfillmentMethod) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::CheckTransferCreateParams::FulfillmentMethod::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # Increase will print and mail a physical check. PHYSICAL_CHECK = @@ -360,14 +359,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::CheckTransferCreateParams::PhysicalCheck::ShippingMethod) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::CheckTransferCreateParams::PhysicalCheck::ShippingMethod::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # USPS First Class USPS_FIRST_CLASS = diff --git a/rbi/lib/increase/models/check_transfer_list_params.rbi b/rbi/lib/increase/models/check_transfer_list_params.rbi index 73c739b57..d05c845af 100644 --- a/rbi/lib/increase/models/check_transfer_list_params.rbi +++ b/rbi/lib/increase/models/check_transfer_list_params.rbi @@ -157,8 +157,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::CheckTransferListParams::Status::In) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::CheckTransferListParams::Status::In::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # The transfer is awaiting approval. PENDING_APPROVAL = diff --git a/rbi/lib/increase/models/check_transfer_stop_payment_params.rbi b/rbi/lib/increase/models/check_transfer_stop_payment_params.rbi index 859f46a60..489d232d8 100644 --- a/rbi/lib/increase/models/check_transfer_stop_payment_params.rbi +++ b/rbi/lib/increase/models/check_transfer_stop_payment_params.rbi @@ -38,8 +38,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::CheckTransferStopPaymentParams::Reason) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::CheckTransferStopPaymentParams::Reason::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # The check could not be delivered. MAIL_DELIVERY_FAILED = diff --git a/rbi/lib/increase/models/declined_transaction.rbi b/rbi/lib/increase/models/declined_transaction.rbi index b4db352b8..e15f5ef74 100644 --- a/rbi/lib/increase/models/declined_transaction.rbi +++ b/rbi/lib/increase/models/declined_transaction.rbi @@ -114,8 +114,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::DeclinedTransaction::Currency) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::DeclinedTransaction::Currency::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # Canadian Dollar (CAD) CAD = T.let(:CAD, Increase::Models::DeclinedTransaction::Currency::TaggedSymbol) @@ -144,8 +143,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::DeclinedTransaction::RouteType) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::DeclinedTransaction::RouteType::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # An Account Number. ACCOUNT_NUMBER = T.let(:account_number, Increase::Models::DeclinedTransaction::RouteType::TaggedSymbol) @@ -419,8 +417,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::DeclinedTransaction::Source::ACHDecline::Reason) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::DeclinedTransaction::Source::ACHDecline::Reason::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # The account number is canceled. ACH_ROUTE_CANCELED = @@ -536,8 +533,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::DeclinedTransaction::Source::ACHDecline::Type) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::DeclinedTransaction::Source::ACHDecline::Type::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } ACH_DECLINE = T.let(:ach_decline, Increase::Models::DeclinedTransaction::Source::ACHDecline::Type::TaggedSymbol) @@ -827,8 +823,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::DeclinedTransaction::Source::CardDecline::Actioner) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::DeclinedTransaction::Source::CardDecline::Actioner::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # This object was actioned by the user through a real-time decision. USER = T.let(:user, Increase::Models::DeclinedTransaction::Source::CardDecline::Actioner::TaggedSymbol) @@ -855,8 +850,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::DeclinedTransaction::Source::CardDecline::Currency) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::DeclinedTransaction::Source::CardDecline::Currency::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # Canadian Dollar (CAD) CAD = T.let(:CAD, Increase::Models::DeclinedTransaction::Source::CardDecline::Currency::TaggedSymbol) @@ -890,8 +884,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::DeclinedTransaction::Source::CardDecline::Direction) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::DeclinedTransaction::Source::CardDecline::Direction::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # A regular card authorization where funds are debited from the cardholder. SETTLEMENT = @@ -966,14 +959,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::DeclinedTransaction::Source::CardDecline::NetworkDetails::Category) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::DeclinedTransaction::Source::CardDecline::NetworkDetails::Category::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # Visa VISA = @@ -1076,14 +1062,7 @@ module Increase T.type_alias do T.all(Symbol, Increase::Models::DeclinedTransaction::Source::CardDecline::NetworkDetails::Visa::ElectronicCommerceIndicator) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::DeclinedTransaction::Source::CardDecline::NetworkDetails::Visa::ElectronicCommerceIndicator::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # Single transaction of a mail/phone order: Use to indicate that the transaction is a mail/phone order purchase, not a recurring transaction or installment payment. For domestic transactions in the US region, this value may also indicate one bill payment transaction in the card-present or card-absent environments. MAIL_PHONE_ORDER = @@ -1161,14 +1140,7 @@ module Increase T.type_alias do T.all(Symbol, Increase::Models::DeclinedTransaction::Source::CardDecline::NetworkDetails::Visa::PointOfServiceEntryMode) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::DeclinedTransaction::Source::CardDecline::NetworkDetails::Visa::PointOfServiceEntryMode::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # Unknown UNKNOWN = @@ -1260,14 +1232,7 @@ module Increase T.type_alias do T.all(Symbol, Increase::Models::DeclinedTransaction::Source::CardDecline::NetworkDetails::Visa::StandInProcessingReason) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::DeclinedTransaction::Source::CardDecline::NetworkDetails::Visa::StandInProcessingReason::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # Increase failed to process the authorization in a timely manner. ISSUER_ERROR = @@ -1379,14 +1344,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::DeclinedTransaction::Source::CardDecline::ProcessingCategory) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::DeclinedTransaction::Source::CardDecline::ProcessingCategory::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # Account funding transactions are transactions used to e.g., fund an account or transfer funds between accounts. ACCOUNT_FUNDING = @@ -1446,14 +1404,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::DeclinedTransaction::Source::CardDecline::RealTimeDecisionReason) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::DeclinedTransaction::Source::CardDecline::RealTimeDecisionReason::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # The cardholder does not have sufficient funds to cover the transaction. The merchant may attempt to process the transaction again. INSUFFICIENT_FUNDS = @@ -1512,8 +1463,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::DeclinedTransaction::Source::CardDecline::Reason) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::DeclinedTransaction::Source::CardDecline::Reason::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # The account has been closed. ACCOUNT_CLOSED = @@ -1606,6 +1556,13 @@ module Increase Increase::Models::DeclinedTransaction::Source::CardDecline::Reason::TaggedSymbol ) + # The transaction was declined because the 3DS authentication failed. + FAILED_3DS_AUTHENTICATION = + T.let( + :failed_3ds_authentication, + Increase::Models::DeclinedTransaction::Source::CardDecline::Reason::TaggedSymbol + ) + # The transaction was suspected to be fraudulent. Please reach out to support@increase.com for more information. SUSPECTED_FRAUD = T.let(:suspected_fraud, Increase::Models::DeclinedTransaction::Source::CardDecline::Reason::TaggedSymbol) @@ -1714,14 +1671,7 @@ module Increase T.type_alias do T.all(Symbol, Increase::Models::DeclinedTransaction::Source::CardDecline::Verification::CardVerificationCode::Result) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::DeclinedTransaction::Source::CardDecline::Verification::CardVerificationCode::Result::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # No card verification code was provided in the authorization request. NOT_CHECKED = @@ -1825,14 +1775,7 @@ module Increase T.type_alias do T.all(Symbol, Increase::Models::DeclinedTransaction::Source::CardDecline::Verification::CardholderAddress::Result) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::DeclinedTransaction::Source::CardDecline::Verification::CardholderAddress::Result::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # No address was provided in the authorization request. NOT_CHECKED = @@ -1896,8 +1839,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::DeclinedTransaction::Source::Category) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::DeclinedTransaction::Source::Category::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # ACH Decline: details will be under the `ach_decline` object. ACH_DECLINE = T.let(:ach_decline, Increase::Models::DeclinedTransaction::Source::Category::TaggedSymbol) @@ -2010,8 +1952,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::DeclinedTransaction::Source::CheckDecline::Reason) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::DeclinedTransaction::Source::CheckDecline::Reason::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # The account number is disabled. ACH_ROUTE_DISABLED = @@ -2192,14 +2133,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::DeclinedTransaction::Source::CheckDepositRejection::Currency) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::DeclinedTransaction::Source::CheckDepositRejection::Currency::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # Canadian Dollar (CAD) CAD = @@ -2240,14 +2174,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::DeclinedTransaction::Source::CheckDepositRejection::Reason) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::DeclinedTransaction::Source::CheckDepositRejection::Reason::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # The check's image is incomplete. INCOMPLETE_IMAGE = @@ -2447,14 +2374,7 @@ module Increase T.type_alias do T.all(Symbol, Increase::Models::DeclinedTransaction::Source::InboundRealTimePaymentsTransferDecline::Currency) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::DeclinedTransaction::Source::InboundRealTimePaymentsTransferDecline::Currency::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # Canadian Dollar (CAD) CAD = @@ -2517,14 +2437,7 @@ module Increase T.type_alias do T.all(Symbol, Increase::Models::DeclinedTransaction::Source::InboundRealTimePaymentsTransferDecline::Reason) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::DeclinedTransaction::Source::InboundRealTimePaymentsTransferDecline::Reason::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # The account number is canceled. ACCOUNT_NUMBER_CANCELED = @@ -2617,8 +2530,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::DeclinedTransaction::Source::WireDecline::Reason) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::DeclinedTransaction::Source::WireDecline::Reason::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # The account number is canceled. ACCOUNT_NUMBER_CANCELED = @@ -2674,8 +2586,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::DeclinedTransaction::Type) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::DeclinedTransaction::Type::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } DECLINED_TRANSACTION = T.let(:declined_transaction, Increase::Models::DeclinedTransaction::Type::TaggedSymbol) diff --git a/rbi/lib/increase/models/declined_transaction_list_params.rbi b/rbi/lib/increase/models/declined_transaction_list_params.rbi index 68a094b78..413884f9f 100644 --- a/rbi/lib/increase/models/declined_transaction_list_params.rbi +++ b/rbi/lib/increase/models/declined_transaction_list_params.rbi @@ -117,8 +117,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::DeclinedTransactionListParams::Category::In) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::DeclinedTransactionListParams::Category::In::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # ACH Decline: details will be under the `ach_decline` object. ACH_DECLINE = diff --git a/rbi/lib/increase/models/digital_card_profile.rbi b/rbi/lib/increase/models/digital_card_profile.rbi index 9938a0b72..ada1b2ba1 100644 --- a/rbi/lib/increase/models/digital_card_profile.rbi +++ b/rbi/lib/increase/models/digital_card_profile.rbi @@ -135,8 +135,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::DigitalCardProfile::Status) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::DigitalCardProfile::Status::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # The Card Profile is awaiting review from Increase and/or processing by card networks. PENDING = T.let(:pending, Increase::Models::DigitalCardProfile::Status::TaggedSymbol) @@ -181,8 +180,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::DigitalCardProfile::Type) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::DigitalCardProfile::Type::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } DIGITAL_CARD_PROFILE = T.let(:digital_card_profile, Increase::Models::DigitalCardProfile::Type::TaggedSymbol) diff --git a/rbi/lib/increase/models/digital_card_profile_list_params.rbi b/rbi/lib/increase/models/digital_card_profile_list_params.rbi index a2f588f32..2017138ef 100644 --- a/rbi/lib/increase/models/digital_card_profile_list_params.rbi +++ b/rbi/lib/increase/models/digital_card_profile_list_params.rbi @@ -89,8 +89,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::DigitalCardProfileListParams::Status::In) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::DigitalCardProfileListParams::Status::In::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # The Card Profile is awaiting review from Increase and/or processing by card networks. PENDING = T.let(:pending, Increase::Models::DigitalCardProfileListParams::Status::In::TaggedSymbol) diff --git a/rbi/lib/increase/models/digital_wallet_token.rbi b/rbi/lib/increase/models/digital_wallet_token.rbi index 8c978530f..ec7034d44 100644 --- a/rbi/lib/increase/models/digital_wallet_token.rbi +++ b/rbi/lib/increase/models/digital_wallet_token.rbi @@ -158,8 +158,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::DigitalWalletToken::Device::DeviceType) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::DigitalWalletToken::Device::DeviceType::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # Unknown UNKNOWN = T.let(:unknown, Increase::Models::DigitalWalletToken::Device::DeviceType::TaggedSymbol) @@ -203,8 +202,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::DigitalWalletToken::Status) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::DigitalWalletToken::Status::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # The digital wallet token is active. ACTIVE = T.let(:active, Increase::Models::DigitalWalletToken::Status::TaggedSymbol) @@ -227,8 +225,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::DigitalWalletToken::TokenRequestor) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::DigitalWalletToken::TokenRequestor::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # Apple Pay APPLE_PAY = T.let(:apple_pay, Increase::Models::DigitalWalletToken::TokenRequestor::TaggedSymbol) @@ -252,8 +249,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::DigitalWalletToken::Type) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::DigitalWalletToken::Type::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } DIGITAL_WALLET_TOKEN = T.let(:digital_wallet_token, Increase::Models::DigitalWalletToken::Type::TaggedSymbol) @@ -289,8 +285,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::DigitalWalletToken::Update::Status) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::DigitalWalletToken::Update::Status::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # The digital wallet token is active. ACTIVE = T.let(:active, Increase::Models::DigitalWalletToken::Update::Status::TaggedSymbol) diff --git a/rbi/lib/increase/models/document.rbi b/rbi/lib/increase/models/document.rbi index 8c8513ee3..9dd95aa88 100644 --- a/rbi/lib/increase/models/document.rbi +++ b/rbi/lib/increase/models/document.rbi @@ -64,7 +64,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::Document::Category) } - OrSymbol = T.type_alias { T.any(Symbol, String, Increase::Models::Document::Category::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # Internal Revenue Service Form 1099-INT. FORM_1099_INT = T.let(:form_1099_int, Increase::Models::Document::Category::TaggedSymbol) @@ -89,7 +89,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::Document::Type) } - OrSymbol = T.type_alias { T.any(Symbol, String, Increase::Models::Document::Type::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } DOCUMENT = T.let(:document, Increase::Models::Document::Type::TaggedSymbol) diff --git a/rbi/lib/increase/models/document_list_params.rbi b/rbi/lib/increase/models/document_list_params.rbi index 4e96d095d..d5d51bdb4 100644 --- a/rbi/lib/increase/models/document_list_params.rbi +++ b/rbi/lib/increase/models/document_list_params.rbi @@ -102,8 +102,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::DocumentListParams::Category::In) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::DocumentListParams::Category::In::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # Internal Revenue Service Form 1099-INT. FORM_1099_INT = T.let(:form_1099_int, Increase::Models::DocumentListParams::Category::In::TaggedSymbol) diff --git a/rbi/lib/increase/models/entity.rbi b/rbi/lib/increase/models/entity.rbi index 44567d827..0c786b833 100644 --- a/rbi/lib/increase/models/entity.rbi +++ b/rbi/lib/increase/models/entity.rbi @@ -508,14 +508,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::Entity::Corporation::BeneficialOwner::Individual::Identification::Method) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::Entity::Corporation::BeneficialOwner::Individual::Identification::Method::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # A social security number. SOCIAL_SECURITY_NUMBER = @@ -569,8 +562,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::Entity::Corporation::BeneficialOwner::Prong) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::Entity::Corporation::BeneficialOwner::Prong::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # A person with 25% or greater direct or indirect ownership of the entity. OWNERSHIP = @@ -712,8 +704,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::Entity::GovernmentAuthority::Category) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::Entity::GovernmentAuthority::Category::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # The Public Entity is a Municipality. MUNICIPALITY = @@ -881,8 +872,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::Entity::Joint::Individual::Identification::Method) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::Entity::Joint::Individual::Identification::Method::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # A social security number. SOCIAL_SECURITY_NUMBER = @@ -1050,8 +1040,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::Entity::NaturalPerson::Identification::Method) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::Entity::NaturalPerson::Identification::Method::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # A social security number. SOCIAL_SECURITY_NUMBER = @@ -1089,7 +1078,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::Entity::Status) } - OrSymbol = T.type_alias { T.any(Symbol, String, Increase::Models::Entity::Status::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # The entity is active. ACTIVE = T.let(:active, Increase::Models::Entity::Status::TaggedSymbol) @@ -1109,7 +1098,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::Entity::Structure) } - OrSymbol = T.type_alias { T.any(Symbol, String, Increase::Models::Entity::Structure::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # A corporation. CORPORATION = T.let(:corporation, Increase::Models::Entity::Structure::TaggedSymbol) @@ -1160,8 +1149,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::Entity::ThirdPartyVerification::Vendor) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::Entity::ThirdPartyVerification::Vendor::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # Alloy. See https://alloy.com for more information. ALLOY = T.let(:alloy, Increase::Models::Entity::ThirdPartyVerification::Vendor::TaggedSymbol) @@ -1306,8 +1294,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::Entity::Trust::Category) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::Entity::Trust::Category::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # The trust is revocable by the grantor. REVOCABLE = T.let(:revocable, Increase::Models::Entity::Trust::Category::TaggedSymbol) @@ -1454,8 +1441,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::Entity::Trust::Grantor::Identification::Method) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::Entity::Trust::Grantor::Identification::Method::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # A social security number. SOCIAL_SECURITY_NUMBER = @@ -1665,14 +1651,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::Entity::Trust::Trustee::Individual::Identification::Method) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::Entity::Trust::Trustee::Individual::Identification::Method::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # A social security number. SOCIAL_SECURITY_NUMBER = @@ -1722,8 +1701,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::Entity::Trust::Trustee::Structure) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::Entity::Trust::Trustee::Structure::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # The trustee is an individual. INDIVIDUAL = T.let(:individual, Increase::Models::Entity::Trust::Trustee::Structure::TaggedSymbol) @@ -1740,7 +1718,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::Entity::Type) } - OrSymbol = T.type_alias { T.any(Symbol, String, Increase::Models::Entity::Type::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } ENTITY = T.let(:entity, Increase::Models::Entity::Type::TaggedSymbol) diff --git a/rbi/lib/increase/models/entity_create_beneficial_owner_params.rbi b/rbi/lib/increase/models/entity_create_beneficial_owner_params.rbi index f60daafc3..c0edf9698 100644 --- a/rbi/lib/increase/models/entity_create_beneficial_owner_params.rbi +++ b/rbi/lib/increase/models/entity_create_beneficial_owner_params.rbi @@ -364,14 +364,7 @@ module Increase T.type_alias do T.all(Symbol, Increase::Models::EntityCreateBeneficialOwnerParams::BeneficialOwner::Individual::Identification::Method) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::EntityCreateBeneficialOwnerParams::BeneficialOwner::Individual::Identification::Method::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # A social security number. SOCIAL_SECURITY_NUMBER = @@ -549,14 +542,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::EntityCreateBeneficialOwnerParams::BeneficialOwner::Prong) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::EntityCreateBeneficialOwnerParams::BeneficialOwner::Prong::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # A person with 25% or greater direct or indirect ownership of the entity. OWNERSHIP = diff --git a/rbi/lib/increase/models/entity_create_params.rbi b/rbi/lib/increase/models/entity_create_params.rbi index 775725026..66997df07 100644 --- a/rbi/lib/increase/models/entity_create_params.rbi +++ b/rbi/lib/increase/models/entity_create_params.rbi @@ -148,8 +148,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::EntityCreateParams::Structure) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::EntityCreateParams::Structure::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # A corporation. CORPORATION = T.let(:corporation, Increase::Models::EntityCreateParams::Structure::TaggedSymbol) @@ -185,8 +184,9 @@ module Increase end attr_writer :address - # The identifying details of anyone controlling or owning 25% or more of the - # corporation. + # The identifying details of each person who owns 25% or more of the business and + # one control person, like the CEO, CFO, or other executive. You can submit + # between 1 and 5 people to this list. sig { returns(T::Array[Increase::Models::EntityCreateParams::Corporation::BeneficialOwner]) } attr_accessor :beneficial_owners @@ -198,6 +198,24 @@ module Increase sig { returns(String) } attr_accessor :tax_identifier + # If the entity is exempt from the requirement to submit beneficial owners, + # provide the justification. If a reason is provided, you do not need to submit a + # list of beneficial owners. + sig do + returns( + T.nilable(Increase::Models::EntityCreateParams::Corporation::BeneficialOwnershipExemptionReason::OrSymbol) + ) + end + attr_reader :beneficial_ownership_exemption_reason + + sig do + params( + beneficial_ownership_exemption_reason: Increase::Models::EntityCreateParams::Corporation::BeneficialOwnershipExemptionReason::OrSymbol + ) + .void + end + attr_writer :beneficial_ownership_exemption_reason + # The two-letter United States Postal Service (USPS) abbreviation for the # corporation's state of incorporation. sig { returns(T.nilable(String)) } @@ -231,6 +249,7 @@ module Increase beneficial_owners: T::Array[T.any(Increase::Models::EntityCreateParams::Corporation::BeneficialOwner, Increase::Internal::AnyHash)], name: String, tax_identifier: String, + beneficial_ownership_exemption_reason: Increase::Models::EntityCreateParams::Corporation::BeneficialOwnershipExemptionReason::OrSymbol, incorporation_state: String, industry_code: String, website: String @@ -242,6 +261,7 @@ module Increase beneficial_owners:, name:, tax_identifier:, + beneficial_ownership_exemption_reason: nil, incorporation_state: nil, industry_code: nil, website: nil @@ -254,6 +274,7 @@ module Increase beneficial_owners: T::Array[Increase::Models::EntityCreateParams::Corporation::BeneficialOwner], name: String, tax_identifier: String, + beneficial_ownership_exemption_reason: Increase::Models::EntityCreateParams::Corporation::BeneficialOwnershipExemptionReason::OrSymbol, incorporation_state: String, industry_code: String, website: String @@ -634,14 +655,7 @@ module Increase T.type_alias do T.all(Symbol, Increase::Models::EntityCreateParams::Corporation::BeneficialOwner::Individual::Identification::Method) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::EntityCreateParams::Corporation::BeneficialOwner::Individual::Identification::Method::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # A social security number. SOCIAL_SECURITY_NUMBER = @@ -819,14 +833,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::EntityCreateParams::Corporation::BeneficialOwner::Prong) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::EntityCreateParams::Corporation::BeneficialOwner::Prong::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # A person with 25% or greater direct or indirect ownership of the entity. OWNERSHIP = @@ -843,6 +850,46 @@ module Increase def self.values; end end end + + # If the entity is exempt from the requirement to submit beneficial owners, + # provide the justification. If a reason is provided, you do not need to submit a + # list of beneficial owners. + module BeneficialOwnershipExemptionReason + extend Increase::Internal::Type::Enum + + TaggedSymbol = + T.type_alias { T.all(Symbol, Increase::Models::EntityCreateParams::Corporation::BeneficialOwnershipExemptionReason) } + OrSymbol = T.type_alias { T.any(Symbol, String) } + + # A regulated financial institution. + REGULATED_FINANCIAL_INSTITUTION = + T.let( + :regulated_financial_institution, + Increase::Models::EntityCreateParams::Corporation::BeneficialOwnershipExemptionReason::TaggedSymbol + ) + + # A publicly traded company. + PUBLICLY_TRADED_COMPANY = + T.let( + :publicly_traded_company, + Increase::Models::EntityCreateParams::Corporation::BeneficialOwnershipExemptionReason::TaggedSymbol + ) + + # A public entity acting on behalf of the federal or a state government. + PUBLIC_ENTITY = + T.let( + :public_entity, + Increase::Models::EntityCreateParams::Corporation::BeneficialOwnershipExemptionReason::TaggedSymbol + ) + + sig do + override + .returns( + T::Array[Increase::Models::EntityCreateParams::Corporation::BeneficialOwnershipExemptionReason::TaggedSymbol] + ) + end + def self.values; end + end end class GovernmentAuthority < Increase::Internal::Type::BaseModel @@ -977,8 +1024,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::EntityCreateParams::GovernmentAuthority::Category) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::EntityCreateParams::GovernmentAuthority::Category::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # The Public Entity is a Municipality. MUNICIPALITY = @@ -1243,14 +1289,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::EntityCreateParams::Joint::Individual::Identification::Method) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::EntityCreateParams::Joint::Individual::Identification::Method::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # A social security number. SOCIAL_SECURITY_NUMBER = @@ -1638,14 +1677,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::EntityCreateParams::NaturalPerson::Identification::Method) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::EntityCreateParams::NaturalPerson::Identification::Method::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # A social security number. SOCIAL_SECURITY_NUMBER = @@ -1850,8 +1882,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::EntityCreateParams::ThirdPartyVerification::Vendor) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::EntityCreateParams::ThirdPartyVerification::Vendor::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # Alloy. See https://alloy.com for more information. ALLOY = T.let(:alloy, Increase::Models::EntityCreateParams::ThirdPartyVerification::Vendor::TaggedSymbol) @@ -2018,8 +2049,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::EntityCreateParams::Trust::Category) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::EntityCreateParams::Trust::Category::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # The trust is revocable by the grantor. REVOCABLE = T.let(:revocable, Increase::Models::EntityCreateParams::Trust::Category::TaggedSymbol) @@ -2075,8 +2105,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::EntityCreateParams::Trust::Trustee::Structure) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::EntityCreateParams::Trust::Trustee::Structure::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # The trustee is an individual. INDIVIDUAL = @@ -2332,14 +2361,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::EntityCreateParams::Trust::Trustee::Individual::Identification::Method) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::EntityCreateParams::Trust::Trustee::Individual::Identification::Method::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # A social security number. SOCIAL_SECURITY_NUMBER = @@ -2724,14 +2746,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::EntityCreateParams::Trust::Grantor::Identification::Method) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::EntityCreateParams::Trust::Grantor::Identification::Method::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # A social security number. SOCIAL_SECURITY_NUMBER = diff --git a/rbi/lib/increase/models/entity_list_params.rbi b/rbi/lib/increase/models/entity_list_params.rbi index 63787840f..271dacf77 100644 --- a/rbi/lib/increase/models/entity_list_params.rbi +++ b/rbi/lib/increase/models/entity_list_params.rbi @@ -141,8 +141,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::EntityListParams::Status::In) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::EntityListParams::Status::In::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # The entity is active. ACTIVE = T.let(:active, Increase::Models::EntityListParams::Status::In::TaggedSymbol) diff --git a/rbi/lib/increase/models/entity_supplemental_document.rbi b/rbi/lib/increase/models/entity_supplemental_document.rbi index 23a0e0557..96f8753da 100644 --- a/rbi/lib/increase/models/entity_supplemental_document.rbi +++ b/rbi/lib/increase/models/entity_supplemental_document.rbi @@ -61,8 +61,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::EntitySupplementalDocument::Type) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::EntitySupplementalDocument::Type::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } ENTITY_SUPPLEMENTAL_DOCUMENT = T.let(:entity_supplemental_document, Increase::Models::EntitySupplementalDocument::Type::TaggedSymbol) diff --git a/rbi/lib/increase/models/event.rbi b/rbi/lib/increase/models/event.rbi index e6a3c427e..83da7b498 100644 --- a/rbi/lib/increase/models/event.rbi +++ b/rbi/lib/increase/models/event.rbi @@ -67,7 +67,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::Event::Category) } - OrSymbol = T.type_alias { T.any(Symbol, String, Increase::Models::Event::Category::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # Occurs whenever an Account is created. ACCOUNT_CREATED = T.let(:"account.created", Increase::Models::Event::Category::TaggedSymbol) @@ -420,7 +420,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::Event::Type) } - OrSymbol = T.type_alias { T.any(Symbol, String, Increase::Models::Event::Type::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } EVENT = T.let(:event, Increase::Models::Event::Type::TaggedSymbol) diff --git a/rbi/lib/increase/models/event_list_params.rbi b/rbi/lib/increase/models/event_list_params.rbi index fb1086476..3d39983b2 100644 --- a/rbi/lib/increase/models/event_list_params.rbi +++ b/rbi/lib/increase/models/event_list_params.rbi @@ -96,8 +96,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::EventListParams::Category::In) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::EventListParams::Category::In::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # Occurs whenever an Account is created. ACCOUNT_CREATED = diff --git a/rbi/lib/increase/models/event_subscription.rbi b/rbi/lib/increase/models/event_subscription.rbi index 65a1cb042..526f9cb15 100644 --- a/rbi/lib/increase/models/event_subscription.rbi +++ b/rbi/lib/increase/models/event_subscription.rbi @@ -94,8 +94,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::EventSubscription::SelectedEventCategory) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::EventSubscription::SelectedEventCategory::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # Occurs whenever an Account is created. ACCOUNT_CREATED = @@ -623,8 +622,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::EventSubscription::Status) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::EventSubscription::Status::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # The subscription is active and Events will be delivered normally. ACTIVE = T.let(:active, Increase::Models::EventSubscription::Status::TaggedSymbol) @@ -649,8 +647,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::EventSubscription::Type) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::EventSubscription::Type::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } EVENT_SUBSCRIPTION = T.let(:event_subscription, Increase::Models::EventSubscription::Type::TaggedSymbol) diff --git a/rbi/lib/increase/models/event_subscription_create_params.rbi b/rbi/lib/increase/models/event_subscription_create_params.rbi index b2d81cb68..920fcc9ed 100644 --- a/rbi/lib/increase/models/event_subscription_create_params.rbi +++ b/rbi/lib/increase/models/event_subscription_create_params.rbi @@ -79,14 +79,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::EventSubscriptionCreateParams::SelectedEventCategory) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::EventSubscriptionCreateParams::SelectedEventCategory::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # Occurs whenever an Account is created. ACCOUNT_CREATED = diff --git a/rbi/lib/increase/models/event_subscription_update_params.rbi b/rbi/lib/increase/models/event_subscription_update_params.rbi index 2b3c46dd2..b10323df3 100644 --- a/rbi/lib/increase/models/event_subscription_update_params.rbi +++ b/rbi/lib/increase/models/event_subscription_update_params.rbi @@ -38,8 +38,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::EventSubscriptionUpdateParams::Status) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::EventSubscriptionUpdateParams::Status::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # The subscription is active and Events will be delivered normally. ACTIVE = T.let(:active, Increase::Models::EventSubscriptionUpdateParams::Status::TaggedSymbol) diff --git a/rbi/lib/increase/models/export.rbi b/rbi/lib/increase/models/export.rbi index dbf49f7e2..df1acb785 100644 --- a/rbi/lib/increase/models/export.rbi +++ b/rbi/lib/increase/models/export.rbi @@ -94,7 +94,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::Export::Category) } - OrSymbol = T.type_alias { T.any(Symbol, String, Increase::Models::Export::Category::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # Export an Open Financial Exchange (OFX) file of transactions and balances for a given time range and Account. ACCOUNT_STATEMENT_OFX = T.let(:account_statement_ofx, Increase::Models::Export::Category::TaggedSymbol) @@ -127,7 +127,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::Export::Status) } - OrSymbol = T.type_alias { T.any(Symbol, String, Increase::Models::Export::Status::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # Increase is generating the export. PENDING = T.let(:pending, Increase::Models::Export::Status::TaggedSymbol) @@ -148,7 +148,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::Export::Type) } - OrSymbol = T.type_alias { T.any(Symbol, String, Increase::Models::Export::Type::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } EXPORT = T.let(:export, Increase::Models::Export::Type::TaggedSymbol) diff --git a/rbi/lib/increase/models/export_create_params.rbi b/rbi/lib/increase/models/export_create_params.rbi index b8ccc046d..860d06684 100644 --- a/rbi/lib/increase/models/export_create_params.rbi +++ b/rbi/lib/increase/models/export_create_params.rbi @@ -122,8 +122,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::ExportCreateParams::Category) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::ExportCreateParams::Category::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # Export an Open Financial Exchange (OFX) file of transactions and balances for a given time range and Account. ACCOUNT_STATEMENT_OFX = @@ -462,8 +461,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::ExportCreateParams::EntityCsv::Status::In) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::ExportCreateParams::EntityCsv::Status::In::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # The entity is active. ACTIVE = T.let(:active, Increase::Models::ExportCreateParams::EntityCsv::Status::In::TaggedSymbol) diff --git a/rbi/lib/increase/models/export_list_params.rbi b/rbi/lib/increase/models/export_list_params.rbi index 47f772de5..a6bc1b983 100644 --- a/rbi/lib/increase/models/export_list_params.rbi +++ b/rbi/lib/increase/models/export_list_params.rbi @@ -108,8 +108,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::ExportListParams::Category::In) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::ExportListParams::Category::In::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # Export an Open Financial Exchange (OFX) file of transactions and balances for a given time range and Account. ACCOUNT_STATEMENT_OFX = @@ -202,8 +201,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::ExportListParams::Status::In) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::ExportListParams::Status::In::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # Increase is generating the export. PENDING = T.let(:pending, Increase::Models::ExportListParams::Status::In::TaggedSymbol) diff --git a/rbi/lib/increase/models/external_account.rbi b/rbi/lib/increase/models/external_account.rbi index 38261d74b..da596344b 100644 --- a/rbi/lib/increase/models/external_account.rbi +++ b/rbi/lib/increase/models/external_account.rbi @@ -107,8 +107,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::ExternalAccount::AccountHolder) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::ExternalAccount::AccountHolder::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # The External Account is owned by a business. BUSINESS = T.let(:business, Increase::Models::ExternalAccount::AccountHolder::TaggedSymbol) @@ -128,8 +127,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::ExternalAccount::Funding) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::ExternalAccount::Funding::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # A checking account. CHECKING = T.let(:checking, Increase::Models::ExternalAccount::Funding::TaggedSymbol) @@ -149,8 +147,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::ExternalAccount::Status) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::ExternalAccount::Status::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # The External Account is active. ACTIVE = T.let(:active, Increase::Models::ExternalAccount::Status::TaggedSymbol) @@ -168,7 +165,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::ExternalAccount::Type) } - OrSymbol = T.type_alias { T.any(Symbol, String, Increase::Models::ExternalAccount::Type::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } EXTERNAL_ACCOUNT = T.let(:external_account, Increase::Models::ExternalAccount::Type::TaggedSymbol) @@ -181,8 +178,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::ExternalAccount::VerificationStatus) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::ExternalAccount::VerificationStatus::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # The External Account has not been verified. UNVERIFIED = T.let(:unverified, Increase::Models::ExternalAccount::VerificationStatus::TaggedSymbol) diff --git a/rbi/lib/increase/models/external_account_create_params.rbi b/rbi/lib/increase/models/external_account_create_params.rbi index 718f1b5fd..ea72a5cc5 100644 --- a/rbi/lib/increase/models/external_account_create_params.rbi +++ b/rbi/lib/increase/models/external_account_create_params.rbi @@ -75,8 +75,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::ExternalAccountCreateParams::AccountHolder) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::ExternalAccountCreateParams::AccountHolder::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # The External Account is owned by a business. BUSINESS = T.let(:business, Increase::Models::ExternalAccountCreateParams::AccountHolder::TaggedSymbol) @@ -97,8 +96,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::ExternalAccountCreateParams::Funding) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::ExternalAccountCreateParams::Funding::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # A checking account. CHECKING = T.let(:checking, Increase::Models::ExternalAccountCreateParams::Funding::TaggedSymbol) diff --git a/rbi/lib/increase/models/external_account_list_params.rbi b/rbi/lib/increase/models/external_account_list_params.rbi index 2e8e4541b..b8d2d38e3 100644 --- a/rbi/lib/increase/models/external_account_list_params.rbi +++ b/rbi/lib/increase/models/external_account_list_params.rbi @@ -106,8 +106,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::ExternalAccountListParams::Status::In) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::ExternalAccountListParams::Status::In::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # The External Account is active. ACTIVE = T.let(:active, Increase::Models::ExternalAccountListParams::Status::In::TaggedSymbol) diff --git a/rbi/lib/increase/models/external_account_update_params.rbi b/rbi/lib/increase/models/external_account_update_params.rbi index efb822bbc..8f11acada 100644 --- a/rbi/lib/increase/models/external_account_update_params.rbi +++ b/rbi/lib/increase/models/external_account_update_params.rbi @@ -66,8 +66,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::ExternalAccountUpdateParams::AccountHolder) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::ExternalAccountUpdateParams::AccountHolder::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # The External Account is owned by a business. BUSINESS = T.let(:business, Increase::Models::ExternalAccountUpdateParams::AccountHolder::TaggedSymbol) @@ -85,8 +84,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::ExternalAccountUpdateParams::Funding) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::ExternalAccountUpdateParams::Funding::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # A checking account. CHECKING = T.let(:checking, Increase::Models::ExternalAccountUpdateParams::Funding::TaggedSymbol) @@ -106,8 +104,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::ExternalAccountUpdateParams::Status) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::ExternalAccountUpdateParams::Status::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # The External Account is active. ACTIVE = T.let(:active, Increase::Models::ExternalAccountUpdateParams::Status::TaggedSymbol) diff --git a/rbi/lib/increase/models/file.rbi b/rbi/lib/increase/models/file.rbi index b910f4a32..58c22154d 100644 --- a/rbi/lib/increase/models/file.rbi +++ b/rbi/lib/increase/models/file.rbi @@ -98,7 +98,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::File::Direction) } - OrSymbol = T.type_alias { T.any(Symbol, String, Increase::Models::File::Direction::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # This File was sent by you to Increase. TO_INCREASE = T.let(:to_increase, Increase::Models::File::Direction::TaggedSymbol) @@ -117,7 +117,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::File::Purpose) } - OrSymbol = T.type_alias { T.any(Symbol, String, Increase::Models::File::Purpose::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # An image of the front of a check, used for check deposits. CHECK_IMAGE_FRONT = T.let(:check_image_front, Increase::Models::File::Purpose::TaggedSymbol) @@ -211,7 +211,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::File::Type) } - OrSymbol = T.type_alias { T.any(Symbol, String, Increase::Models::File::Type::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } FILE = T.let(:file, Increase::Models::File::Type::TaggedSymbol) diff --git a/rbi/lib/increase/models/file_create_params.rbi b/rbi/lib/increase/models/file_create_params.rbi index bad9bb745..385fc3454 100644 --- a/rbi/lib/increase/models/file_create_params.rbi +++ b/rbi/lib/increase/models/file_create_params.rbi @@ -52,8 +52,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::FileCreateParams::Purpose) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::FileCreateParams::Purpose::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # An image of the front of a check, used for check deposits. CHECK_IMAGE_FRONT = T.let(:check_image_front, Increase::Models::FileCreateParams::Purpose::TaggedSymbol) diff --git a/rbi/lib/increase/models/file_link.rbi b/rbi/lib/increase/models/file_link.rbi index b43925f86..7e575d97a 100644 --- a/rbi/lib/increase/models/file_link.rbi +++ b/rbi/lib/increase/models/file_link.rbi @@ -76,7 +76,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::FileLink::Type) } - OrSymbol = T.type_alias { T.any(Symbol, String, Increase::Models::FileLink::Type::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } FILE_LINK = T.let(:file_link, Increase::Models::FileLink::Type::TaggedSymbol) diff --git a/rbi/lib/increase/models/file_list_params.rbi b/rbi/lib/increase/models/file_list_params.rbi index a028ecd21..a88328849 100644 --- a/rbi/lib/increase/models/file_list_params.rbi +++ b/rbi/lib/increase/models/file_list_params.rbi @@ -140,8 +140,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::FileListParams::Purpose::In) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::FileListParams::Purpose::In::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # An image of the front of a check, used for check deposits. CHECK_IMAGE_FRONT = diff --git a/rbi/lib/increase/models/group.rbi b/rbi/lib/increase/models/group.rbi index 1cc3ac997..8db3b6b54 100644 --- a/rbi/lib/increase/models/group.rbi +++ b/rbi/lib/increase/models/group.rbi @@ -60,7 +60,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::Group::ACHDebitStatus) } - OrSymbol = T.type_alias { T.any(Symbol, String, Increase::Models::Group::ACHDebitStatus::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # The Group cannot make ACH debits. DISABLED = T.let(:disabled, Increase::Models::Group::ACHDebitStatus::TaggedSymbol) @@ -77,8 +77,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::Group::ActivationStatus) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::Group::ActivationStatus::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # The Group is not activated. UNACTIVATED = T.let(:unactivated, Increase::Models::Group::ActivationStatus::TaggedSymbol) @@ -96,7 +95,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::Group::Type) } - OrSymbol = T.type_alias { T.any(Symbol, String, Increase::Models::Group::Type::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } GROUP = T.let(:group, Increase::Models::Group::Type::TaggedSymbol) diff --git a/rbi/lib/increase/models/inbound_ach_transfer.rbi b/rbi/lib/increase/models/inbound_ach_transfer.rbi index a95b1b538..270a01b39 100644 --- a/rbi/lib/increase/models/inbound_ach_transfer.rbi +++ b/rbi/lib/increase/models/inbound_ach_transfer.rbi @@ -327,8 +327,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::InboundACHTransfer::Addenda::Category) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::InboundACHTransfer::Addenda::Category::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # Unstructured addendum. FREEFORM = T.let(:freeform, Increase::Models::InboundACHTransfer::Addenda::Category::TaggedSymbol) @@ -409,8 +408,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::InboundACHTransfer::Decline::Reason) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::InboundACHTransfer::Decline::Reason::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # The account number is canceled. ACH_ROUTE_CANCELED = @@ -507,8 +505,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::InboundACHTransfer::Direction) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::InboundACHTransfer::Direction::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # Credit CREDIT = T.let(:credit, Increase::Models::InboundACHTransfer::Direction::TaggedSymbol) @@ -526,8 +523,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::InboundACHTransfer::ExpectedSettlementSchedule) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::InboundACHTransfer::ExpectedSettlementSchedule::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # The transfer is expected to settle same-day. SAME_DAY = @@ -837,14 +833,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::InboundACHTransfer::InternationalAddenda::ForeignExchangeIndicator) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::InboundACHTransfer::InternationalAddenda::ForeignExchangeIndicator::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # The originator chose an amount in their own currency. The settled amount in USD was converted using the exchange rate. FIXED_TO_VARIABLE = @@ -885,14 +874,7 @@ module Increase T.type_alias do T.all(Symbol, Increase::Models::InboundACHTransfer::InternationalAddenda::ForeignExchangeReferenceIndicator) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::InboundACHTransfer::InternationalAddenda::ForeignExchangeReferenceIndicator::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # The ACH file contains a foreign exchange rate. FOREIGN_EXCHANGE_RATE = @@ -934,14 +916,7 @@ module Increase T.type_alias do T.all(Symbol, Increase::Models::InboundACHTransfer::InternationalAddenda::InternationalTransactionTypeCode) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::InboundACHTransfer::InternationalAddenda::InternationalTransactionTypeCode::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # Sent as `ANN` in the Nacha file. ANNUITY = @@ -1101,14 +1076,7 @@ module Increase T.type_alias do T.all(Symbol, Increase::Models::InboundACHTransfer::InternationalAddenda::OriginatingDepositoryFinancialInstitutionIDQualifier) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::InboundACHTransfer::InternationalAddenda::OriginatingDepositoryFinancialInstitutionIDQualifier::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # A domestic clearing system number. In the US, for example, this is the American Banking Association (ABA) routing number. NATIONAL_CLEARING_SYSTEM_NUMBER = @@ -1151,14 +1119,7 @@ module Increase T.type_alias do T.all(Symbol, Increase::Models::InboundACHTransfer::InternationalAddenda::ReceivingDepositoryFinancialInstitutionIDQualifier) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::InboundACHTransfer::InternationalAddenda::ReceivingDepositoryFinancialInstitutionIDQualifier::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # A domestic clearing system number. In the US, for example, this is the American Banking Association (ABA) routing number. NATIONAL_CLEARING_SYSTEM_NUMBER = @@ -1227,8 +1188,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::InboundACHTransfer::StandardEntryClassCode) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::InboundACHTransfer::StandardEntryClassCode::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # Corporate Credit and Debit (CCD). CORPORATE_CREDIT_OR_DEBIT = @@ -1318,8 +1278,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::InboundACHTransfer::Status) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::InboundACHTransfer::Status::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # The Inbound ACH Transfer is awaiting action, will transition automatically if no action is taken. PENDING = T.let(:pending, Increase::Models::InboundACHTransfer::Status::TaggedSymbol) @@ -1379,8 +1338,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::InboundACHTransfer::TransferReturn::Reason) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::InboundACHTransfer::TransferReturn::Reason::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # The customer's account has insufficient funds. This reason is only allowed for debits. The Nacha return code is R01. INSUFFICIENT_FUNDS = @@ -1454,8 +1412,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::InboundACHTransfer::Type) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::InboundACHTransfer::Type::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } INBOUND_ACH_TRANSFER = T.let(:inbound_ach_transfer, Increase::Models::InboundACHTransfer::Type::TaggedSymbol) diff --git a/rbi/lib/increase/models/inbound_ach_transfer_decline_params.rbi b/rbi/lib/increase/models/inbound_ach_transfer_decline_params.rbi index 3b0e1ac0c..30ce9022f 100644 --- a/rbi/lib/increase/models/inbound_ach_transfer_decline_params.rbi +++ b/rbi/lib/increase/models/inbound_ach_transfer_decline_params.rbi @@ -42,8 +42,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::InboundACHTransferDeclineParams::Reason) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::InboundACHTransferDeclineParams::Reason::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # The customer's account has insufficient funds. This reason is only allowed for debits. The Nacha return code is R01. INSUFFICIENT_FUNDS = diff --git a/rbi/lib/increase/models/inbound_ach_transfer_list_params.rbi b/rbi/lib/increase/models/inbound_ach_transfer_list_params.rbi index 7e542c6ac..cedf811d0 100644 --- a/rbi/lib/increase/models/inbound_ach_transfer_list_params.rbi +++ b/rbi/lib/increase/models/inbound_ach_transfer_list_params.rbi @@ -157,8 +157,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::InboundACHTransferListParams::Status::In) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::InboundACHTransferListParams::Status::In::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # The Inbound ACH Transfer is awaiting action, will transition automatically if no action is taken. PENDING = T.let(:pending, Increase::Models::InboundACHTransferListParams::Status::In::TaggedSymbol) diff --git a/rbi/lib/increase/models/inbound_ach_transfer_transfer_return_params.rbi b/rbi/lib/increase/models/inbound_ach_transfer_transfer_return_params.rbi index 5b92361ce..ae20df4a7 100644 --- a/rbi/lib/increase/models/inbound_ach_transfer_transfer_return_params.rbi +++ b/rbi/lib/increase/models/inbound_ach_transfer_transfer_return_params.rbi @@ -38,8 +38,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::InboundACHTransferTransferReturnParams::Reason) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::InboundACHTransferTransferReturnParams::Reason::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # The customer's account has insufficient funds. This reason is only allowed for debits. The Nacha return code is R01. INSUFFICIENT_FUNDS = diff --git a/rbi/lib/increase/models/inbound_check_deposit.rbi b/rbi/lib/increase/models/inbound_check_deposit.rbi index 2fbde5286..715cdd599 100644 --- a/rbi/lib/increase/models/inbound_check_deposit.rbi +++ b/rbi/lib/increase/models/inbound_check_deposit.rbi @@ -229,8 +229,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::InboundCheckDeposit::Adjustment::Reason) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::InboundCheckDeposit::Adjustment::Reason::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # The return was initiated too late and the receiving institution has responded with a Late Return Claim. LATE_RETURN = @@ -258,8 +257,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::InboundCheckDeposit::Currency) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::InboundCheckDeposit::Currency::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # Canadian Dollar (CAD) CAD = T.let(:CAD, Increase::Models::InboundCheckDeposit::Currency::TaggedSymbol) @@ -326,8 +324,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::InboundCheckDeposit::DepositReturn::Reason) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::InboundCheckDeposit::DepositReturn::Reason::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # The check was altered or fictitious. ALTERED_OR_FICTITIOUS = @@ -360,8 +357,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::InboundCheckDeposit::PayeeNameAnalysis) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::InboundCheckDeposit::PayeeNameAnalysis::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # The details on the check match the recipient name of the check transfer. NAME_MATCHES = @@ -384,8 +380,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::InboundCheckDeposit::Status) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::InboundCheckDeposit::Status::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # The Inbound Check Deposit is pending. PENDING = T.let(:pending, Increase::Models::InboundCheckDeposit::Status::TaggedSymbol) @@ -413,8 +408,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::InboundCheckDeposit::Type) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::InboundCheckDeposit::Type::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } INBOUND_CHECK_DEPOSIT = T.let(:inbound_check_deposit, Increase::Models::InboundCheckDeposit::Type::TaggedSymbol) diff --git a/rbi/lib/increase/models/inbound_check_deposit_return_params.rbi b/rbi/lib/increase/models/inbound_check_deposit_return_params.rbi index 4cee609da..a2bbef5c5 100644 --- a/rbi/lib/increase/models/inbound_check_deposit_return_params.rbi +++ b/rbi/lib/increase/models/inbound_check_deposit_return_params.rbi @@ -35,8 +35,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::InboundCheckDepositReturnParams::Reason) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::InboundCheckDepositReturnParams::Reason::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # The check was altered or fictitious. ALTERED_OR_FICTITIOUS = diff --git a/rbi/lib/increase/models/inbound_mail_item.rbi b/rbi/lib/increase/models/inbound_mail_item.rbi index dd9a86cb5..ed45cddb0 100644 --- a/rbi/lib/increase/models/inbound_mail_item.rbi +++ b/rbi/lib/increase/models/inbound_mail_item.rbi @@ -86,8 +86,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::InboundMailItem::RejectionReason) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::InboundMailItem::RejectionReason::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # The mail item does not match any lockbox. NO_MATCHING_LOCKBOX = @@ -109,8 +108,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::InboundMailItem::Status) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::InboundMailItem::Status::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # The mail item is pending processing. PENDING = T.let(:pending, Increase::Models::InboundMailItem::Status::TaggedSymbol) @@ -131,7 +129,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::InboundMailItem::Type) } - OrSymbol = T.type_alias { T.any(Symbol, String, Increase::Models::InboundMailItem::Type::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } INBOUND_MAIL_ITEM = T.let(:inbound_mail_item, Increase::Models::InboundMailItem::Type::TaggedSymbol) diff --git a/rbi/lib/increase/models/inbound_real_time_payments_transfer.rbi b/rbi/lib/increase/models/inbound_real_time_payments_transfer.rbi index d3034a95c..4ded64d5a 100644 --- a/rbi/lib/increase/models/inbound_real_time_payments_transfer.rbi +++ b/rbi/lib/increase/models/inbound_real_time_payments_transfer.rbi @@ -180,8 +180,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::InboundRealTimePaymentsTransfer::Currency) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::InboundRealTimePaymentsTransfer::Currency::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # Canadian Dollar (CAD) CAD = T.let(:CAD, Increase::Models::InboundRealTimePaymentsTransfer::Currency::TaggedSymbol) @@ -247,8 +246,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::InboundRealTimePaymentsTransfer::Decline::Reason) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::InboundRealTimePaymentsTransfer::Decline::Reason::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # The account number is canceled. ACCOUNT_NUMBER_CANCELED = @@ -302,8 +300,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::InboundRealTimePaymentsTransfer::Status) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::InboundRealTimePaymentsTransfer::Status::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # The transfer is pending confirmation. PENDING_CONFIRMING = @@ -328,8 +325,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::InboundRealTimePaymentsTransfer::Type) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::InboundRealTimePaymentsTransfer::Type::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } INBOUND_REAL_TIME_PAYMENTS_TRANSFER = T.let( diff --git a/rbi/lib/increase/models/inbound_wire_drawdown_request.rbi b/rbi/lib/increase/models/inbound_wire_drawdown_request.rbi index 27072e6c0..4c83bcce5 100644 --- a/rbi/lib/increase/models/inbound_wire_drawdown_request.rbi +++ b/rbi/lib/increase/models/inbound_wire_drawdown_request.rbi @@ -50,7 +50,7 @@ module Increase attr_accessor :message_to_recipient # The drawdown request's originator's account number. - sig { returns(String) } + sig { returns(T.nilable(String)) } attr_accessor :originator_account_number # Line 1 of the drawdown request's originator's address. @@ -119,7 +119,7 @@ module Increase created_at: Time, currency: String, message_to_recipient: T.nilable(String), - originator_account_number: String, + originator_account_number: T.nilable(String), originator_address_line1: T.nilable(String), originator_address_line2: T.nilable(String), originator_address_line3: T.nilable(String), @@ -174,7 +174,7 @@ module Increase created_at: Time, currency: String, message_to_recipient: T.nilable(String), - originator_account_number: String, + originator_account_number: T.nilable(String), originator_address_line1: T.nilable(String), originator_address_line2: T.nilable(String), originator_address_line3: T.nilable(String), @@ -197,8 +197,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::InboundWireDrawdownRequest::Type) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::InboundWireDrawdownRequest::Type::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } INBOUND_WIRE_DRAWDOWN_REQUEST = T.let(:inbound_wire_drawdown_request, Increase::Models::InboundWireDrawdownRequest::Type::TaggedSymbol) diff --git a/rbi/lib/increase/models/inbound_wire_transfer.rbi b/rbi/lib/increase/models/inbound_wire_transfer.rbi index 31bc27688..d568b774b 100644 --- a/rbi/lib/increase/models/inbound_wire_transfer.rbi +++ b/rbi/lib/increase/models/inbound_wire_transfer.rbi @@ -206,8 +206,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::InboundWireTransfer::Status) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::InboundWireTransfer::Status::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # The Inbound Wire Transfer is awaiting action, will transition automatically if no action is taken. PENDING = T.let(:pending, Increase::Models::InboundWireTransfer::Status::TaggedSymbol) @@ -231,8 +230,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::InboundWireTransfer::Type) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::InboundWireTransfer::Type::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } INBOUND_WIRE_TRANSFER = T.let(:inbound_wire_transfer, Increase::Models::InboundWireTransfer::Type::TaggedSymbol) diff --git a/rbi/lib/increase/models/inbound_wire_transfer_list_params.rbi b/rbi/lib/increase/models/inbound_wire_transfer_list_params.rbi index ff214f498..97d1e8861 100644 --- a/rbi/lib/increase/models/inbound_wire_transfer_list_params.rbi +++ b/rbi/lib/increase/models/inbound_wire_transfer_list_params.rbi @@ -160,8 +160,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::InboundWireTransferListParams::Status::In) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::InboundWireTransferListParams::Status::In::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # The Inbound Wire Transfer is awaiting action, will transition automatically if no action is taken. PENDING = T.let(:pending, Increase::Models::InboundWireTransferListParams::Status::In::TaggedSymbol) diff --git a/rbi/lib/increase/models/intrafi_account_enrollment.rbi b/rbi/lib/increase/models/intrafi_account_enrollment.rbi index e668e8a6f..cf25c1bc2 100644 --- a/rbi/lib/increase/models/intrafi_account_enrollment.rbi +++ b/rbi/lib/increase/models/intrafi_account_enrollment.rbi @@ -80,8 +80,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::IntrafiAccountEnrollment::Status) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::IntrafiAccountEnrollment::Status::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # The account is being added to the IntraFi network. PENDING_ENROLLING = @@ -111,8 +110,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::IntrafiAccountEnrollment::Type) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::IntrafiAccountEnrollment::Type::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } INTRAFI_ACCOUNT_ENROLLMENT = T.let(:intrafi_account_enrollment, Increase::Models::IntrafiAccountEnrollment::Type::TaggedSymbol) diff --git a/rbi/lib/increase/models/intrafi_account_enrollment_list_params.rbi b/rbi/lib/increase/models/intrafi_account_enrollment_list_params.rbi index 0991aaf2f..71c506948 100644 --- a/rbi/lib/increase/models/intrafi_account_enrollment_list_params.rbi +++ b/rbi/lib/increase/models/intrafi_account_enrollment_list_params.rbi @@ -112,8 +112,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::IntrafiAccountEnrollmentListParams::Status::In) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::IntrafiAccountEnrollmentListParams::Status::In::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # The account is being added to the IntraFi network. PENDING_ENROLLING = diff --git a/rbi/lib/increase/models/intrafi_balance.rbi b/rbi/lib/increase/models/intrafi_balance.rbi index b54d222cc..8d41c734d 100644 --- a/rbi/lib/increase/models/intrafi_balance.rbi +++ b/rbi/lib/increase/models/intrafi_balance.rbi @@ -143,8 +143,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::IntrafiBalance::Currency) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::IntrafiBalance::Currency::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # Canadian Dollar (CAD) CAD = T.let(:CAD, Increase::Models::IntrafiBalance::Currency::TaggedSymbol) @@ -174,7 +173,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::IntrafiBalance::Type) } - OrSymbol = T.type_alias { T.any(Symbol, String, Increase::Models::IntrafiBalance::Type::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } INTRAFI_BALANCE = T.let(:intrafi_balance, Increase::Models::IntrafiBalance::Type::TaggedSymbol) diff --git a/rbi/lib/increase/models/intrafi_exclusion.rbi b/rbi/lib/increase/models/intrafi_exclusion.rbi index a1757c8e0..ee4525c5c 100644 --- a/rbi/lib/increase/models/intrafi_exclusion.rbi +++ b/rbi/lib/increase/models/intrafi_exclusion.rbi @@ -103,8 +103,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::IntrafiExclusion::Status) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::IntrafiExclusion::Status::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # The exclusion is being added to the IntraFi network. PENDING = T.let(:pending, Increase::Models::IntrafiExclusion::Status::TaggedSymbol) @@ -125,7 +124,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::IntrafiExclusion::Type) } - OrSymbol = T.type_alias { T.any(Symbol, String, Increase::Models::IntrafiExclusion::Type::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } INTRAFI_EXCLUSION = T.let(:intrafi_exclusion, Increase::Models::IntrafiExclusion::Type::TaggedSymbol) diff --git a/rbi/lib/increase/models/lockbox.rbi b/rbi/lib/increase/models/lockbox.rbi index 1f8dbcf37..b417b1a9e 100644 --- a/rbi/lib/increase/models/lockbox.rbi +++ b/rbi/lib/increase/models/lockbox.rbi @@ -158,7 +158,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::Lockbox::Status) } - OrSymbol = T.type_alias { T.any(Symbol, String, Increase::Models::Lockbox::Status::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # This Lockbox is active. Checks mailed to it will be deposited automatically. ACTIVE = T.let(:active, Increase::Models::Lockbox::Status::TaggedSymbol) @@ -176,7 +176,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::Lockbox::Type) } - OrSymbol = T.type_alias { T.any(Symbol, String, Increase::Models::Lockbox::Type::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } LOCKBOX = T.let(:lockbox, Increase::Models::Lockbox::Type::TaggedSymbol) diff --git a/rbi/lib/increase/models/lockbox_update_params.rbi b/rbi/lib/increase/models/lockbox_update_params.rbi index 763da5321..2341c86da 100644 --- a/rbi/lib/increase/models/lockbox_update_params.rbi +++ b/rbi/lib/increase/models/lockbox_update_params.rbi @@ -56,8 +56,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::LockboxUpdateParams::Status) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::LockboxUpdateParams::Status::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # This Lockbox is active. Checks mailed to it will be deposited automatically. ACTIVE = T.let(:active, Increase::Models::LockboxUpdateParams::Status::TaggedSymbol) diff --git a/rbi/lib/increase/models/oauth_application.rbi b/rbi/lib/increase/models/oauth_application.rbi index f24d08ab8..56b264f2c 100644 --- a/rbi/lib/increase/models/oauth_application.rbi +++ b/rbi/lib/increase/models/oauth_application.rbi @@ -74,8 +74,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::OAuthApplication::Status) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::OAuthApplication::Status::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # The application is active and can be used by your users. ACTIVE = T.let(:active, Increase::Models::OAuthApplication::Status::TaggedSymbol) @@ -93,7 +92,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::OAuthApplication::Type) } - OrSymbol = T.type_alias { T.any(Symbol, String, Increase::Models::OAuthApplication::Type::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } OAUTH_APPLICATION = T.let(:oauth_application, Increase::Models::OAuthApplication::Type::TaggedSymbol) diff --git a/rbi/lib/increase/models/oauth_application_list_params.rbi b/rbi/lib/increase/models/oauth_application_list_params.rbi index 70937d8a2..75cfa6883 100644 --- a/rbi/lib/increase/models/oauth_application_list_params.rbi +++ b/rbi/lib/increase/models/oauth_application_list_params.rbi @@ -131,8 +131,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::OAuthApplicationListParams::Status::In) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::OAuthApplicationListParams::Status::In::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # The application is active and can be used by your users. ACTIVE = T.let(:active, Increase::Models::OAuthApplicationListParams::Status::In::TaggedSymbol) diff --git a/rbi/lib/increase/models/oauth_connection.rbi b/rbi/lib/increase/models/oauth_connection.rbi index 1ccca386d..ecd7acde4 100644 --- a/rbi/lib/increase/models/oauth_connection.rbi +++ b/rbi/lib/increase/models/oauth_connection.rbi @@ -72,8 +72,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::OAuthConnection::Status) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::OAuthConnection::Status::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # The OAuth connection is active. ACTIVE = T.let(:active, Increase::Models::OAuthConnection::Status::TaggedSymbol) @@ -91,7 +90,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::OAuthConnection::Type) } - OrSymbol = T.type_alias { T.any(Symbol, String, Increase::Models::OAuthConnection::Type::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } OAUTH_CONNECTION = T.let(:oauth_connection, Increase::Models::OAuthConnection::Type::TaggedSymbol) diff --git a/rbi/lib/increase/models/oauth_connection_list_params.rbi b/rbi/lib/increase/models/oauth_connection_list_params.rbi index 4f55b7977..59936d7e6 100644 --- a/rbi/lib/increase/models/oauth_connection_list_params.rbi +++ b/rbi/lib/increase/models/oauth_connection_list_params.rbi @@ -87,8 +87,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::OAuthConnectionListParams::Status::In) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::OAuthConnectionListParams::Status::In::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # The OAuth connection is active. ACTIVE = T.let(:active, Increase::Models::OAuthConnectionListParams::Status::In::TaggedSymbol) diff --git a/rbi/lib/increase/models/oauth_token.rbi b/rbi/lib/increase/models/oauth_token.rbi index affec6217..33833fbb3 100644 --- a/rbi/lib/increase/models/oauth_token.rbi +++ b/rbi/lib/increase/models/oauth_token.rbi @@ -47,7 +47,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::OAuthToken::TokenType) } - OrSymbol = T.type_alias { T.any(Symbol, String, Increase::Models::OAuthToken::TokenType::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } BEARER = T.let(:bearer, Increase::Models::OAuthToken::TokenType::TaggedSymbol) @@ -61,7 +61,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::OAuthToken::Type) } - OrSymbol = T.type_alias { T.any(Symbol, String, Increase::Models::OAuthToken::Type::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } OAUTH_TOKEN = T.let(:oauth_token, Increase::Models::OAuthToken::Type::TaggedSymbol) diff --git a/rbi/lib/increase/models/oauth_token_create_params.rbi b/rbi/lib/increase/models/oauth_token_create_params.rbi index f1b87d9df..6ed968e1c 100644 --- a/rbi/lib/increase/models/oauth_token_create_params.rbi +++ b/rbi/lib/increase/models/oauth_token_create_params.rbi @@ -86,8 +86,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::OAuthTokenCreateParams::GrantType) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::OAuthTokenCreateParams::GrantType::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # An OAuth authorization code. AUTHORIZATION_CODE = diff --git a/rbi/lib/increase/models/pending_transaction.rbi b/rbi/lib/increase/models/pending_transaction.rbi index 8a83c5bc3..e54c5e3c7 100644 --- a/rbi/lib/increase/models/pending_transaction.rbi +++ b/rbi/lib/increase/models/pending_transaction.rbi @@ -127,8 +127,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::PendingTransaction::Currency) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::PendingTransaction::Currency::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # Canadian Dollar (CAD) CAD = T.let(:CAD, Increase::Models::PendingTransaction::Currency::TaggedSymbol) @@ -157,8 +156,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::PendingTransaction::RouteType) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::PendingTransaction::RouteType::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # An Account Number. ACCOUNT_NUMBER = T.let(:account_number, Increase::Models::PendingTransaction::RouteType::TaggedSymbol) @@ -460,14 +458,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::PendingTransaction::Source::AccountTransferInstruction::Currency) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::PendingTransaction::Source::AccountTransferInstruction::Currency::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # Canadian Dollar (CAD) CAD = @@ -814,14 +805,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::PendingTransaction::Source::CardAuthorization::Actioner) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::PendingTransaction::Source::CardAuthorization::Actioner::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # This object was actioned by the user through a real-time decision. USER = @@ -849,14 +833,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::PendingTransaction::Source::CardAuthorization::Currency) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::PendingTransaction::Source::CardAuthorization::Currency::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # Canadian Dollar (CAD) CAD = @@ -896,14 +873,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::PendingTransaction::Source::CardAuthorization::Direction) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::PendingTransaction::Source::CardAuthorization::Direction::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # A regular card authorization where funds are debited from the cardholder. SETTLEMENT = @@ -983,14 +953,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::PendingTransaction::Source::CardAuthorization::NetworkDetails::Category) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::PendingTransaction::Source::CardAuthorization::NetworkDetails::Category::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # Visa VISA = @@ -1093,14 +1056,7 @@ module Increase T.type_alias do T.all(Symbol, Increase::Models::PendingTransaction::Source::CardAuthorization::NetworkDetails::Visa::ElectronicCommerceIndicator) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::PendingTransaction::Source::CardAuthorization::NetworkDetails::Visa::ElectronicCommerceIndicator::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # Single transaction of a mail/phone order: Use to indicate that the transaction is a mail/phone order purchase, not a recurring transaction or installment payment. For domestic transactions in the US region, this value may also indicate one bill payment transaction in the card-present or card-absent environments. MAIL_PHONE_ORDER = @@ -1178,14 +1134,7 @@ module Increase T.type_alias do T.all(Symbol, Increase::Models::PendingTransaction::Source::CardAuthorization::NetworkDetails::Visa::PointOfServiceEntryMode) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::PendingTransaction::Source::CardAuthorization::NetworkDetails::Visa::PointOfServiceEntryMode::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # Unknown UNKNOWN = @@ -1277,14 +1226,7 @@ module Increase T.type_alias do T.all(Symbol, Increase::Models::PendingTransaction::Source::CardAuthorization::NetworkDetails::Visa::StandInProcessingReason) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::PendingTransaction::Source::CardAuthorization::NetworkDetails::Visa::StandInProcessingReason::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # Increase failed to process the authorization in a timely manner. ISSUER_ERROR = @@ -1396,14 +1338,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::PendingTransaction::Source::CardAuthorization::ProcessingCategory) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::PendingTransaction::Source::CardAuthorization::ProcessingCategory::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # Account funding transactions are transactions used to e.g., fund an account or transfer funds between accounts. ACCOUNT_FUNDING = @@ -1463,8 +1398,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::PendingTransaction::Source::CardAuthorization::Type) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::PendingTransaction::Source::CardAuthorization::Type::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } CARD_AUTHORIZATION = T.let( @@ -1580,14 +1514,7 @@ module Increase T.type_alias do T.all(Symbol, Increase::Models::PendingTransaction::Source::CardAuthorization::Verification::CardVerificationCode::Result) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::PendingTransaction::Source::CardAuthorization::Verification::CardVerificationCode::Result::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # No card verification code was provided in the authorization request. NOT_CHECKED = @@ -1691,14 +1618,7 @@ module Increase T.type_alias do T.all(Symbol, Increase::Models::PendingTransaction::Source::CardAuthorization::Verification::CardholderAddress::Result) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::PendingTransaction::Source::CardAuthorization::Verification::CardholderAddress::Result::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # No address was provided in the authorization request. NOT_CHECKED = @@ -1762,8 +1682,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::PendingTransaction::Source::Category) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::PendingTransaction::Source::Category::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # Account Transfer Instruction: details will be under the `account_transfer_instruction` object. ACCOUNT_TRANSFER_INSTRUCTION = @@ -1873,14 +1792,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::PendingTransaction::Source::CheckDepositInstruction::Currency) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::PendingTransaction::Source::CheckDepositInstruction::Currency::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # Canadian Dollar (CAD) CAD = @@ -1961,14 +1873,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::PendingTransaction::Source::CheckTransferInstruction::Currency) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::PendingTransaction::Source::CheckTransferInstruction::Currency::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # Canadian Dollar (CAD) CAD = @@ -2125,14 +2030,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::PendingTransaction::Source::InboundFundsHold::Currency) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::PendingTransaction::Source::InboundFundsHold::Currency::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # Canadian Dollar (CAD) CAD = T.let(:CAD, Increase::Models::PendingTransaction::Source::InboundFundsHold::Currency::TaggedSymbol) @@ -2165,14 +2063,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::PendingTransaction::Source::InboundFundsHold::Status) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::PendingTransaction::Source::InboundFundsHold::Status::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # Funds are still being held. HELD = T.let(:held, Increase::Models::PendingTransaction::Source::InboundFundsHold::Status::TaggedSymbol) @@ -2195,8 +2086,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::PendingTransaction::Source::InboundFundsHold::Type) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::PendingTransaction::Source::InboundFundsHold::Type::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } INBOUND_FUNDS_HOLD = T.let( @@ -2306,8 +2196,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::PendingTransaction::Status) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::PendingTransaction::Status::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # The Pending Transaction is still awaiting confirmation. PENDING = T.let(:pending, Increase::Models::PendingTransaction::Status::TaggedSymbol) @@ -2325,8 +2214,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::PendingTransaction::Type) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::PendingTransaction::Type::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } PENDING_TRANSACTION = T.let(:pending_transaction, Increase::Models::PendingTransaction::Type::TaggedSymbol) diff --git a/rbi/lib/increase/models/pending_transaction_list_params.rbi b/rbi/lib/increase/models/pending_transaction_list_params.rbi index 347015faa..da8517d56 100644 --- a/rbi/lib/increase/models/pending_transaction_list_params.rbi +++ b/rbi/lib/increase/models/pending_transaction_list_params.rbi @@ -129,8 +129,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::PendingTransactionListParams::Category::In) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::PendingTransactionListParams::Category::In::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # Account Transfer Instruction: details will be under the `account_transfer_instruction` object. ACCOUNT_TRANSFER_INSTRUCTION = @@ -263,8 +262,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::PendingTransactionListParams::Status::In) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::PendingTransactionListParams::Status::In::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # The Pending Transaction is still awaiting confirmation. PENDING = T.let(:pending, Increase::Models::PendingTransactionListParams::Status::In::TaggedSymbol) diff --git a/rbi/lib/increase/models/physical_card.rbi b/rbi/lib/increase/models/physical_card.rbi index 48643bbe8..95abffbc9 100644 --- a/rbi/lib/increase/models/physical_card.rbi +++ b/rbi/lib/increase/models/physical_card.rbi @@ -235,8 +235,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::PhysicalCard::Shipment::Method) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::PhysicalCard::Shipment::Method::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # USPS Post with tracking. USPS = T.let(:usps, Increase::Models::PhysicalCard::Shipment::Method::TaggedSymbol) @@ -257,8 +256,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::PhysicalCard::Shipment::Status) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::PhysicalCard::Shipment::Status::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # The physical card has not yet been shipped. PENDING = T.let(:pending, Increase::Models::PhysicalCard::Shipment::Status::TaggedSymbol) @@ -336,7 +334,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::PhysicalCard::Status) } - OrSymbol = T.type_alias { T.any(Symbol, String, Increase::Models::PhysicalCard::Status::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # The physical card is active. ACTIVE = T.let(:active, Increase::Models::PhysicalCard::Status::TaggedSymbol) @@ -357,7 +355,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::PhysicalCard::Type) } - OrSymbol = T.type_alias { T.any(Symbol, String, Increase::Models::PhysicalCard::Type::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } PHYSICAL_CARD = T.let(:physical_card, Increase::Models::PhysicalCard::Type::TaggedSymbol) diff --git a/rbi/lib/increase/models/physical_card_create_params.rbi b/rbi/lib/increase/models/physical_card_create_params.rbi index 24f539b4c..05177eeb9 100644 --- a/rbi/lib/increase/models/physical_card_create_params.rbi +++ b/rbi/lib/increase/models/physical_card_create_params.rbi @@ -204,8 +204,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::PhysicalCardCreateParams::Shipment::Method) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::PhysicalCardCreateParams::Shipment::Method::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # USPS Post with tracking. USPS = T.let(:usps, Increase::Models::PhysicalCardCreateParams::Shipment::Method::TaggedSymbol) diff --git a/rbi/lib/increase/models/physical_card_profile.rbi b/rbi/lib/increase/models/physical_card_profile.rbi index 3ffa59ab6..91c792f84 100644 --- a/rbi/lib/increase/models/physical_card_profile.rbi +++ b/rbi/lib/increase/models/physical_card_profile.rbi @@ -123,8 +123,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::PhysicalCardProfile::Creator) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::PhysicalCardProfile::Creator::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # This Physical Card Profile was created by Increase. INCREASE = T.let(:increase, Increase::Models::PhysicalCardProfile::Creator::TaggedSymbol) @@ -141,8 +140,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::PhysicalCardProfile::Status) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::PhysicalCardProfile::Status::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # The Card Profile has not yet been processed by Increase. PENDING_CREATING = T.let(:pending_creating, Increase::Models::PhysicalCardProfile::Status::TaggedSymbol) @@ -174,8 +172,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::PhysicalCardProfile::Type) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::PhysicalCardProfile::Type::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } PHYSICAL_CARD_PROFILE = T.let(:physical_card_profile, Increase::Models::PhysicalCardProfile::Type::TaggedSymbol) diff --git a/rbi/lib/increase/models/physical_card_profile_list_params.rbi b/rbi/lib/increase/models/physical_card_profile_list_params.rbi index 6073bfc6a..ffc55f88b 100644 --- a/rbi/lib/increase/models/physical_card_profile_list_params.rbi +++ b/rbi/lib/increase/models/physical_card_profile_list_params.rbi @@ -92,8 +92,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::PhysicalCardProfileListParams::Status::In) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::PhysicalCardProfileListParams::Status::In::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # The Card Profile has not yet been processed by Increase. PENDING_CREATING = diff --git a/rbi/lib/increase/models/physical_card_update_params.rbi b/rbi/lib/increase/models/physical_card_update_params.rbi index 14769fe7d..18e7d9eab 100644 --- a/rbi/lib/increase/models/physical_card_update_params.rbi +++ b/rbi/lib/increase/models/physical_card_update_params.rbi @@ -35,8 +35,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::PhysicalCardUpdateParams::Status) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::PhysicalCardUpdateParams::Status::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # The physical card is active. ACTIVE = T.let(:active, Increase::Models::PhysicalCardUpdateParams::Status::TaggedSymbol) diff --git a/rbi/lib/increase/models/program.rbi b/rbi/lib/increase/models/program.rbi index 3849473aa..0927a9076 100644 --- a/rbi/lib/increase/models/program.rbi +++ b/rbi/lib/increase/models/program.rbi @@ -96,7 +96,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::Program::Bank) } - OrSymbol = T.type_alias { T.any(Symbol, String, Increase::Models::Program::Bank::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # Core Bank CORE_BANK = T.let(:core_bank, Increase::Models::Program::Bank::TaggedSymbol) @@ -117,7 +117,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::Program::Type) } - OrSymbol = T.type_alias { T.any(Symbol, String, Increase::Models::Program::Type::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } PROGRAM = T.let(:program, Increase::Models::Program::Type::TaggedSymbol) diff --git a/rbi/lib/increase/models/proof_of_authorization_request.rbi b/rbi/lib/increase/models/proof_of_authorization_request.rbi index 3ec40a476..d5170ee2b 100644 --- a/rbi/lib/increase/models/proof_of_authorization_request.rbi +++ b/rbi/lib/increase/models/proof_of_authorization_request.rbi @@ -75,8 +75,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::ProofOfAuthorizationRequest::Type) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::ProofOfAuthorizationRequest::Type::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } PROOF_OF_AUTHORIZATION_REQUEST = T.let(:proof_of_authorization_request, Increase::Models::ProofOfAuthorizationRequest::Type::TaggedSymbol) diff --git a/rbi/lib/increase/models/proof_of_authorization_request_submission.rbi b/rbi/lib/increase/models/proof_of_authorization_request_submission.rbi index 55340d149..263c5a513 100644 --- a/rbi/lib/increase/models/proof_of_authorization_request_submission.rbi +++ b/rbi/lib/increase/models/proof_of_authorization_request_submission.rbi @@ -7,9 +7,9 @@ module Increase sig { returns(String) } attr_accessor :id - # File containing additional evidence. - sig { returns(T.nilable(String)) } - attr_accessor :additional_evidence_file_id + # Files containing additional evidence. + sig { returns(T::Array[Increase::Models::ProofOfAuthorizationRequestSubmission::AdditionalEvidenceFile]) } + attr_accessor :additional_evidence_files # Terms of authorization. sig { returns(String) } @@ -86,7 +86,12 @@ module Increase sig do params( id: String, - additional_evidence_file_id: T.nilable(String), + additional_evidence_files: T::Array[ + T.any( + Increase::Models::ProofOfAuthorizationRequestSubmission::AdditionalEvidenceFile, + Increase::Internal::AnyHash + ) + ], authorization_terms: String, authorized_at: Time, authorizer_company: T.nilable(String), @@ -108,7 +113,7 @@ module Increase end def self.new( id:, - additional_evidence_file_id:, + additional_evidence_files:, authorization_terms:, authorized_at:, authorizer_company:, @@ -131,7 +136,7 @@ module Increase .returns( { id: String, - additional_evidence_file_id: T.nilable(String), + additional_evidence_files: T::Array[Increase::Models::ProofOfAuthorizationRequestSubmission::AdditionalEvidenceFile], authorization_terms: String, authorized_at: Time, authorizer_company: T.nilable(String), @@ -153,14 +158,25 @@ module Increase end def to_hash; end + class AdditionalEvidenceFile < Increase::Internal::Type::BaseModel + # The File identifier. + sig { returns(String) } + attr_accessor :file_id + + sig { params(file_id: String).returns(T.attached_class) } + def self.new(file_id:); end + + sig { override.returns({file_id: String}) } + def to_hash; end + end + # Status of the proof of authorization request submission. module Status extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::ProofOfAuthorizationRequestSubmission::Status) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::ProofOfAuthorizationRequestSubmission::Status::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # The proof of authorization request submission is pending review. PENDING_REVIEW = @@ -192,8 +208,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::ProofOfAuthorizationRequestSubmission::Type) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::ProofOfAuthorizationRequestSubmission::Type::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } PROOF_OF_AUTHORIZATION_REQUEST_SUBMISSION = T.let( diff --git a/rbi/lib/increase/models/real_time_decision.rbi b/rbi/lib/increase/models/real_time_decision.rbi index 25e917746..8c9c0e2ff 100644 --- a/rbi/lib/increase/models/real_time_decision.rbi +++ b/rbi/lib/increase/models/real_time_decision.rbi @@ -200,8 +200,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::RealTimeDecision::CardAuthentication::Decision) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::RealTimeDecision::CardAuthentication::Decision::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # Approve the authentication attempt without triggering a challenge. APPROVE = T.let(:approve, Increase::Models::RealTimeDecision::CardAuthentication::Decision::TaggedSymbol) @@ -273,14 +272,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::RealTimeDecision::CardAuthenticationChallenge::Result) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::RealTimeDecision::CardAuthenticationChallenge::Result::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # Your application successfully delivered the one-time code to the cardholder. SUCCESS = @@ -550,8 +542,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::RealTimeDecision::CardAuthorization::Decision) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::RealTimeDecision::CardAuthorization::Decision::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # Approve the authorization. APPROVE = T.let(:approve, Increase::Models::RealTimeDecision::CardAuthorization::Decision::TaggedSymbol) @@ -570,8 +561,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::RealTimeDecision::CardAuthorization::Direction) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::RealTimeDecision::CardAuthorization::Direction::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # A regular card authorization where funds are debited from the cardholder. SETTLEMENT = @@ -638,14 +628,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::RealTimeDecision::CardAuthorization::NetworkDetails::Category) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::RealTimeDecision::CardAuthorization::NetworkDetails::Category::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # Visa VISA = @@ -748,14 +731,7 @@ module Increase T.type_alias do T.all(Symbol, Increase::Models::RealTimeDecision::CardAuthorization::NetworkDetails::Visa::ElectronicCommerceIndicator) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::RealTimeDecision::CardAuthorization::NetworkDetails::Visa::ElectronicCommerceIndicator::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # Single transaction of a mail/phone order: Use to indicate that the transaction is a mail/phone order purchase, not a recurring transaction or installment payment. For domestic transactions in the US region, this value may also indicate one bill payment transaction in the card-present or card-absent environments. MAIL_PHONE_ORDER = @@ -833,14 +809,7 @@ module Increase T.type_alias do T.all(Symbol, Increase::Models::RealTimeDecision::CardAuthorization::NetworkDetails::Visa::PointOfServiceEntryMode) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::RealTimeDecision::CardAuthorization::NetworkDetails::Visa::PointOfServiceEntryMode::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # Unknown UNKNOWN = @@ -932,14 +901,7 @@ module Increase T.type_alias do T.all(Symbol, Increase::Models::RealTimeDecision::CardAuthorization::NetworkDetails::Visa::StandInProcessingReason) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::RealTimeDecision::CardAuthorization::NetworkDetails::Visa::StandInProcessingReason::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # Increase failed to process the authorization in a timely manner. ISSUER_ERROR = @@ -1051,14 +1013,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::RealTimeDecision::CardAuthorization::ProcessingCategory) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::RealTimeDecision::CardAuthorization::ProcessingCategory::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # Account funding transactions are transactions used to e.g., fund an account or transfer funds between accounts. ACCOUNT_FUNDING = @@ -1169,14 +1124,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::RealTimeDecision::CardAuthorization::RequestDetails::Category) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::RealTimeDecision::CardAuthorization::RequestDetails::Category::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # A regular, standalone authorization. INITIAL_AUTHORIZATION = @@ -1322,14 +1270,7 @@ module Increase T.type_alias do T.all(Symbol, Increase::Models::RealTimeDecision::CardAuthorization::Verification::CardVerificationCode::Result) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::RealTimeDecision::CardAuthorization::Verification::CardVerificationCode::Result::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # No card verification code was provided in the authorization request. NOT_CHECKED = @@ -1427,14 +1368,7 @@ module Increase T.type_alias do T.all(Symbol, Increase::Models::RealTimeDecision::CardAuthorization::Verification::CardholderAddress::Result) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::RealTimeDecision::CardAuthorization::Verification::CardholderAddress::Result::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # No address was provided in the authorization request. NOT_CHECKED = @@ -1497,8 +1431,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::RealTimeDecision::Category) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::RealTimeDecision::Category::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # A card is being authorized. CARD_AUTHORIZATION_REQUESTED = @@ -1597,14 +1530,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::RealTimeDecision::DigitalWalletAuthentication::Channel) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::RealTimeDecision::DigitalWalletAuthentication::Channel::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # Send one-time passcodes over SMS. SMS = T.let(:sms, Increase::Models::RealTimeDecision::DigitalWalletAuthentication::Channel::TaggedSymbol) @@ -1626,14 +1552,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::RealTimeDecision::DigitalWalletAuthentication::DigitalWallet) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::RealTimeDecision::DigitalWalletAuthentication::DigitalWallet::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # Apple Pay APPLE_PAY = @@ -1678,14 +1597,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::RealTimeDecision::DigitalWalletAuthentication::Result) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::RealTimeDecision::DigitalWalletAuthentication::Result::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # Your application successfully delivered the one-time passcode to the cardholder. SUCCESS = @@ -1769,8 +1681,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::RealTimeDecision::DigitalWalletToken::Decision) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::RealTimeDecision::DigitalWalletToken::Decision::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # Approve the provisioning request. APPROVE = T.let(:approve, Increase::Models::RealTimeDecision::DigitalWalletToken::Decision::TaggedSymbol) @@ -1801,8 +1712,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::RealTimeDecision::DigitalWalletToken::DigitalWallet) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::RealTimeDecision::DigitalWalletToken::DigitalWallet::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # Apple Pay APPLE_PAY = @@ -1833,8 +1743,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::RealTimeDecision::Status) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::RealTimeDecision::Status::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # The decision is pending action via real-time webhook. PENDING = T.let(:pending, Increase::Models::RealTimeDecision::Status::TaggedSymbol) @@ -1855,7 +1764,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::RealTimeDecision::Type) } - OrSymbol = T.type_alias { T.any(Symbol, String, Increase::Models::RealTimeDecision::Type::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } REAL_TIME_DECISION = T.let(:real_time_decision, Increase::Models::RealTimeDecision::Type::TaggedSymbol) diff --git a/rbi/lib/increase/models/real_time_decision_action_params.rbi b/rbi/lib/increase/models/real_time_decision_action_params.rbi index aa6a2e6c9..e4f4c3689 100644 --- a/rbi/lib/increase/models/real_time_decision_action_params.rbi +++ b/rbi/lib/increase/models/real_time_decision_action_params.rbi @@ -144,14 +144,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::RealTimeDecisionActionParams::CardAuthentication::Decision) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::RealTimeDecisionActionParams::CardAuthentication::Decision::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # Approve the authentication attempt without triggering a challenge. APPROVE = @@ -212,14 +205,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::RealTimeDecisionActionParams::CardAuthenticationChallenge::Result) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::RealTimeDecisionActionParams::CardAuthenticationChallenge::Result::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # Your application successfully delivered the one-time code to the cardholder. SUCCESS = @@ -295,14 +281,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::RealTimeDecisionActionParams::CardAuthorization::Decision) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::RealTimeDecisionActionParams::CardAuthorization::Decision::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # Approve the authorization. APPROVE = @@ -328,14 +307,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::RealTimeDecisionActionParams::CardAuthorization::DeclineReason) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::RealTimeDecisionActionParams::CardAuthorization::DeclineReason::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # The cardholder does not have sufficient funds to cover the transaction. The merchant may attempt to process the transaction again. INSUFFICIENT_FUNDS = @@ -439,14 +411,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::RealTimeDecisionActionParams::DigitalWalletAuthentication::Result) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::RealTimeDecisionActionParams::DigitalWalletAuthentication::Result::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # Your application successfully delivered the one-time passcode to the cardholder. SUCCESS = diff --git a/rbi/lib/increase/models/real_time_payments_transfer.rbi b/rbi/lib/increase/models/real_time_payments_transfer.rbi index be688367b..07921bc3e 100644 --- a/rbi/lib/increase/models/real_time_payments_transfer.rbi +++ b/rbi/lib/increase/models/real_time_payments_transfer.rbi @@ -415,8 +415,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::RealTimePaymentsTransfer::CreatedBy::Category) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::RealTimePaymentsTransfer::CreatedBy::Category::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # An API key. Details will be under the `api_key` object. API_KEY = T.let(:api_key, Increase::Models::RealTimePaymentsTransfer::CreatedBy::Category::TaggedSymbol) @@ -465,8 +464,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::RealTimePaymentsTransfer::Currency) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::RealTimePaymentsTransfer::Currency::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # Canadian Dollar (CAD) CAD = T.let(:CAD, Increase::Models::RealTimePaymentsTransfer::Currency::TaggedSymbol) @@ -537,14 +535,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::RealTimePaymentsTransfer::Rejection::RejectReasonCode) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::RealTimePaymentsTransfer::Rejection::RejectReasonCode::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # The destination account is closed. Corresponds to the Real-Time Payments reason code `AC04`. ACCOUNT_CLOSED = @@ -697,8 +688,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::RealTimePaymentsTransfer::Status) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::RealTimePaymentsTransfer::Status::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # The transfer is pending approval. PENDING_APPROVAL = @@ -759,8 +749,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::RealTimePaymentsTransfer::Type) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::RealTimePaymentsTransfer::Type::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } REAL_TIME_PAYMENTS_TRANSFER = T.let(:real_time_payments_transfer, Increase::Models::RealTimePaymentsTransfer::Type::TaggedSymbol) diff --git a/rbi/lib/increase/models/real_time_payments_transfer_list_params.rbi b/rbi/lib/increase/models/real_time_payments_transfer_list_params.rbi index f33677a64..6b22b540d 100644 --- a/rbi/lib/increase/models/real_time_payments_transfer_list_params.rbi +++ b/rbi/lib/increase/models/real_time_payments_transfer_list_params.rbi @@ -176,8 +176,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::RealTimePaymentsTransferListParams::Status::In) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::RealTimePaymentsTransferListParams::Status::In::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # The transfer is pending approval. PENDING_APPROVAL = diff --git a/rbi/lib/increase/models/routing_number_list_response.rbi b/rbi/lib/increase/models/routing_number_list_response.rbi index 0e9aaee5a..59c2fccb1 100644 --- a/rbi/lib/increase/models/routing_number_list_response.rbi +++ b/rbi/lib/increase/models/routing_number_list_response.rbi @@ -70,8 +70,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::RoutingNumberListResponse::ACHTransfers) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::RoutingNumberListResponse::ACHTransfers::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # The routing number can receive this transfer type. SUPPORTED = T.let(:supported, Increase::Models::RoutingNumberListResponse::ACHTransfers::TaggedSymbol) @@ -90,14 +89,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::RoutingNumberListResponse::RealTimePaymentsTransfers) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::RoutingNumberListResponse::RealTimePaymentsTransfers::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # The routing number can receive this transfer type. SUPPORTED = @@ -123,8 +115,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::RoutingNumberListResponse::Type) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::RoutingNumberListResponse::Type::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } ROUTING_NUMBER = T.let(:routing_number, Increase::Models::RoutingNumberListResponse::Type::TaggedSymbol) @@ -137,8 +128,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::RoutingNumberListResponse::WireTransfers) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::RoutingNumberListResponse::WireTransfers::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # The routing number can receive this transfer type. SUPPORTED = T.let(:supported, Increase::Models::RoutingNumberListResponse::WireTransfers::TaggedSymbol) diff --git a/rbi/lib/increase/models/simulations/ach_transfer_create_notification_of_change_params.rbi b/rbi/lib/increase/models/simulations/ach_transfer_create_notification_of_change_params.rbi index a1f775ab7..d4e1bc5d9 100644 --- a/rbi/lib/increase/models/simulations/ach_transfer_create_notification_of_change_params.rbi +++ b/rbi/lib/increase/models/simulations/ach_transfer_create_notification_of_change_params.rbi @@ -43,14 +43,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::Simulations::ACHTransferCreateNotificationOfChangeParams::ChangeCode) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::Simulations::ACHTransferCreateNotificationOfChangeParams::ChangeCode::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # The account number was incorrect. INCORRECT_ACCOUNT_NUMBER = diff --git a/rbi/lib/increase/models/simulations/ach_transfer_return_params.rbi b/rbi/lib/increase/models/simulations/ach_transfer_return_params.rbi index a1e34e952..23681d2ed 100644 --- a/rbi/lib/increase/models/simulations/ach_transfer_return_params.rbi +++ b/rbi/lib/increase/models/simulations/ach_transfer_return_params.rbi @@ -42,8 +42,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::Simulations::ACHTransferReturnParams::Reason) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::Simulations::ACHTransferReturnParams::Reason::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # Code R01. Insufficient funds in the receiving account. Sometimes abbreviated to NSF. INSUFFICIENT_FUND = diff --git a/rbi/lib/increase/models/simulations/card_authorization_create_params.rbi b/rbi/lib/increase/models/simulations/card_authorization_create_params.rbi index 8f96af8de..5c37e7dc2 100644 --- a/rbi/lib/increase/models/simulations/card_authorization_create_params.rbi +++ b/rbi/lib/increase/models/simulations/card_authorization_create_params.rbi @@ -226,14 +226,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::Simulations::CardAuthorizationCreateParams::DeclineReason) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::Simulations::CardAuthorizationCreateParams::DeclineReason::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # The account has been closed. ACCOUNT_CLOSED = @@ -347,6 +340,13 @@ module Increase Increase::Models::Simulations::CardAuthorizationCreateParams::DeclineReason::TaggedSymbol ) + # The transaction was declined because the 3DS authentication failed. + FAILED_3DS_AUTHENTICATION = + T.let( + :failed_3ds_authentication, + Increase::Models::Simulations::CardAuthorizationCreateParams::DeclineReason::TaggedSymbol + ) + # The transaction was suspected to be fraudulent. Please reach out to support@increase.com for more information. SUSPECTED_FRAUD = T.let( @@ -370,14 +370,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::Simulations::CardAuthorizationCreateParams::Direction) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::Simulations::CardAuthorizationCreateParams::Direction::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # A regular card authorization where funds are debited from the cardholder. SETTLEMENT = @@ -474,14 +467,7 @@ module Increase T.type_alias do T.all(Symbol, Increase::Models::Simulations::CardAuthorizationCreateParams::NetworkDetails::Visa::StandInProcessingReason) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::Simulations::CardAuthorizationCreateParams::NetworkDetails::Visa::StandInProcessingReason::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # Increase failed to process the authorization in a timely manner. ISSUER_ERROR = diff --git a/rbi/lib/increase/models/simulations/card_authorization_create_response.rbi b/rbi/lib/increase/models/simulations/card_authorization_create_response.rbi index d8a7bca18..7b0e1fb7b 100644 --- a/rbi/lib/increase/models/simulations/card_authorization_create_response.rbi +++ b/rbi/lib/increase/models/simulations/card_authorization_create_response.rbi @@ -67,8 +67,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::Simulations::CardAuthorizationCreateResponse::Type) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::Simulations::CardAuthorizationCreateResponse::Type::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } INBOUND_CARD_AUTHORIZATION_SIMULATION_RESULT = T.let( diff --git a/rbi/lib/increase/models/simulations/card_dispute_action_params.rbi b/rbi/lib/increase/models/simulations/card_dispute_action_params.rbi index 092323407..9a5840103 100644 --- a/rbi/lib/increase/models/simulations/card_dispute_action_params.rbi +++ b/rbi/lib/increase/models/simulations/card_dispute_action_params.rbi @@ -46,8 +46,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::Simulations::CardDisputeActionParams::Status) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::Simulations::CardDisputeActionParams::Status::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # Increase has requested more information related to the Card Dispute from you. PENDING_USER_INFORMATION = diff --git a/rbi/lib/increase/models/simulations/digital_wallet_token_request_create_response.rbi b/rbi/lib/increase/models/simulations/digital_wallet_token_request_create_response.rbi index 4a09e0431..c0ae0e91c 100644 --- a/rbi/lib/increase/models/simulations/digital_wallet_token_request_create_response.rbi +++ b/rbi/lib/increase/models/simulations/digital_wallet_token_request_create_response.rbi @@ -57,14 +57,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::Simulations::DigitalWalletTokenRequestCreateResponse::DeclineReason) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::Simulations::DigitalWalletTokenRequestCreateResponse::DeclineReason::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # The card is not active. CARD_NOT_ACTIVE = @@ -110,14 +103,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::Simulations::DigitalWalletTokenRequestCreateResponse::Type) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::Simulations::DigitalWalletTokenRequestCreateResponse::Type::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } INBOUND_DIGITAL_WALLET_TOKEN_REQUEST_SIMULATION_RESULT = T.let( diff --git a/rbi/lib/increase/models/simulations/inbound_ach_transfer_create_params.rbi b/rbi/lib/increase/models/simulations/inbound_ach_transfer_create_params.rbi index 1d41610e4..54390fd3b 100644 --- a/rbi/lib/increase/models/simulations/inbound_ach_transfer_create_params.rbi +++ b/rbi/lib/increase/models/simulations/inbound_ach_transfer_create_params.rbi @@ -148,14 +148,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::Simulations::InboundACHTransferCreateParams::StandardEntryClassCode) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::Simulations::InboundACHTransferCreateParams::StandardEntryClassCode::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # Corporate Credit and Debit (CCD). CORPORATE_CREDIT_OR_DEBIT = diff --git a/rbi/lib/increase/models/simulations/inbound_funds_hold_release_response.rbi b/rbi/lib/increase/models/simulations/inbound_funds_hold_release_response.rbi index 1600498e1..d778eb306 100644 --- a/rbi/lib/increase/models/simulations/inbound_funds_hold_release_response.rbi +++ b/rbi/lib/increase/models/simulations/inbound_funds_hold_release_response.rbi @@ -104,14 +104,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::Simulations::InboundFundsHoldReleaseResponse::Currency) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::Simulations::InboundFundsHoldReleaseResponse::Currency::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # Canadian Dollar (CAD) CAD = T.let(:CAD, Increase::Models::Simulations::InboundFundsHoldReleaseResponse::Currency::TaggedSymbol) @@ -144,14 +137,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::Simulations::InboundFundsHoldReleaseResponse::Status) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::Simulations::InboundFundsHoldReleaseResponse::Status::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # Funds are still being held. HELD = T.let(:held, Increase::Models::Simulations::InboundFundsHoldReleaseResponse::Status::TaggedSymbol) @@ -174,8 +160,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::Simulations::InboundFundsHoldReleaseResponse::Type) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::Simulations::InboundFundsHoldReleaseResponse::Type::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } INBOUND_FUNDS_HOLD = T.let( diff --git a/rbi/lib/increase/models/simulations/physical_card_advance_shipment_params.rbi b/rbi/lib/increase/models/simulations/physical_card_advance_shipment_params.rbi index 0aae52317..ea3638b9d 100644 --- a/rbi/lib/increase/models/simulations/physical_card_advance_shipment_params.rbi +++ b/rbi/lib/increase/models/simulations/physical_card_advance_shipment_params.rbi @@ -37,14 +37,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::Simulations::PhysicalCardAdvanceShipmentParams::ShipmentStatus) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::Simulations::PhysicalCardAdvanceShipmentParams::ShipmentStatus::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # The physical card has not yet been shipped. PENDING = diff --git a/rbi/lib/increase/models/simulations/real_time_payments_transfer_complete_params.rbi b/rbi/lib/increase/models/simulations/real_time_payments_transfer_complete_params.rbi index 265bc95a5..4c8f0da33 100644 --- a/rbi/lib/increase/models/simulations/real_time_payments_transfer_complete_params.rbi +++ b/rbi/lib/increase/models/simulations/real_time_payments_transfer_complete_params.rbi @@ -81,14 +81,7 @@ module Increase T.type_alias do T.all(Symbol, Increase::Models::Simulations::RealTimePaymentsTransferCompleteParams::Rejection::RejectReasonCode) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::Simulations::RealTimePaymentsTransferCompleteParams::Rejection::RejectReasonCode::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # The destination account is closed. Corresponds to the Real-Time Payments reason code `AC04`. ACCOUNT_CLOSED = diff --git a/rbi/lib/increase/models/transaction.rbi b/rbi/lib/increase/models/transaction.rbi index eba75f7b2..04ad2ca81 100644 --- a/rbi/lib/increase/models/transaction.rbi +++ b/rbi/lib/increase/models/transaction.rbi @@ -114,7 +114,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::Transaction::Currency) } - OrSymbol = T.type_alias { T.any(Symbol, String, Increase::Models::Transaction::Currency::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # Canadian Dollar (CAD) CAD = T.let(:CAD, Increase::Models::Transaction::Currency::TaggedSymbol) @@ -143,7 +143,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::Transaction::RouteType) } - OrSymbol = T.type_alias { T.any(Symbol, String, Increase::Models::Transaction::RouteType::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # An Account Number. ACCOUNT_NUMBER = T.let(:account_number, Increase::Models::Transaction::RouteType::TaggedSymbol) @@ -852,14 +852,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::Transaction::Source::AccountTransferIntention::Currency) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::Transaction::Source::AccountTransferIntention::Currency::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # Canadian Dollar (CAD) CAD = @@ -1042,14 +1035,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::Transaction::Source::ACHTransferReturn::ReturnReasonCode) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::Transaction::Source::ACHTransferReturn::ReturnReasonCode::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # Code R01. Insufficient funds in the receiving account. Sometimes abbreviated to NSF. INSUFFICIENT_FUND = @@ -1864,8 +1850,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::Transaction::Source::CardRefund::Cashback::Currency) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::Transaction::Source::CardRefund::Cashback::Currency::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # Canadian Dollar (CAD) CAD = T.let(:CAD, Increase::Models::Transaction::Source::CardRefund::Cashback::Currency::TaggedSymbol) @@ -1900,8 +1885,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::Transaction::Source::CardRefund::Currency) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::Transaction::Source::CardRefund::Currency::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # Canadian Dollar (CAD) CAD = T.let(:CAD, Increase::Models::Transaction::Source::CardRefund::Currency::TaggedSymbol) @@ -1972,14 +1956,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::Transaction::Source::CardRefund::Interchange::Currency) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::Transaction::Source::CardRefund::Interchange::Currency::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # Canadian Dollar (CAD) CAD = T.let(:CAD, Increase::Models::Transaction::Source::CardRefund::Interchange::Currency::TaggedSymbol) @@ -2365,14 +2342,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::CarRental::ExtraCharges) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::CarRental::ExtraCharges::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # No extra charge NO_EXTRA_CHARGE = @@ -2434,14 +2404,7 @@ module Increase T.type_alias do T.all(Symbol, Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::CarRental::NoShowIndicator) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::CarRental::NoShowIndicator::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # Not applicable NOT_APPLICABLE = @@ -2632,14 +2595,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::Lodging::ExtraCharges) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::Lodging::ExtraCharges::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # No extra charge NO_EXTRA_CHARGE = @@ -2708,14 +2664,7 @@ module Increase T.type_alias do T.all(Symbol, Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::Lodging::NoShowIndicator) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::Lodging::NoShowIndicator::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # Not applicable NOT_APPLICABLE = @@ -2749,14 +2698,7 @@ module Increase T.type_alias do T.all(Symbol, Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::PurchaseIdentifierFormat) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::PurchaseIdentifierFormat::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # Free text FREE_TEXT = @@ -3045,14 +2987,7 @@ module Increase T.type_alias do T.all(Symbol, Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::Travel::Ancillary::CreditReasonIndicator) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::Travel::Ancillary::CreditReasonIndicator::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # No credit NO_CREDIT = @@ -3140,14 +3075,7 @@ module Increase T.type_alias do T.all(Symbol, Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::Travel::Ancillary::Service::Category) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::Travel::Ancillary::Service::Category::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # None NONE = @@ -3338,14 +3266,7 @@ module Increase T.type_alias do T.all(Symbol, Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::Travel::CreditReasonIndicator) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::Travel::CreditReasonIndicator::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # No credit NO_CREDIT = @@ -3408,14 +3329,7 @@ module Increase T.type_alias do T.all(Symbol, Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::Travel::RestrictedTicketIndicator) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::Travel::RestrictedTicketIndicator::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # No restrictions NO_RESTRICTIONS = @@ -3450,14 +3364,7 @@ module Increase T.type_alias do T.all(Symbol, Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::Travel::TicketChangeIndicator) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::Travel::TicketChangeIndicator::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # None NONE = @@ -3568,14 +3475,7 @@ module Increase T.type_alias do T.all(Symbol, Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::Travel::TripLeg::StopOverCode) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::Travel::TripLeg::StopOverCode::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # None NONE = @@ -3618,8 +3518,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::Transaction::Source::CardRefund::Type) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::Transaction::Source::CardRefund::Type::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } CARD_REFUND = T.let(:card_refund, Increase::Models::Transaction::Source::CardRefund::Type::TaggedSymbol) @@ -3687,8 +3586,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::Transaction::Source::CardRevenuePayment::Currency) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::Transaction::Source::CardRevenuePayment::Currency::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # Canadian Dollar (CAD) CAD = T.let(:CAD, Increase::Models::Transaction::Source::CardRevenuePayment::Currency::TaggedSymbol) @@ -3982,14 +3880,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::Transaction::Source::CardSettlement::Cashback::Currency) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::Transaction::Source::CardSettlement::Cashback::Currency::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # Canadian Dollar (CAD) CAD = @@ -4030,8 +3921,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::Transaction::Source::CardSettlement::Currency) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::Transaction::Source::CardSettlement::Currency::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # Canadian Dollar (CAD) CAD = T.let(:CAD, Increase::Models::Transaction::Source::CardSettlement::Currency::TaggedSymbol) @@ -4102,14 +3992,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::Transaction::Source::CardSettlement::Interchange::Currency) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::Transaction::Source::CardSettlement::Interchange::Currency::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # Canadian Dollar (CAD) CAD = @@ -4505,14 +4388,7 @@ module Increase T.type_alias do T.all(Symbol, Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::CarRental::ExtraCharges) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::CarRental::ExtraCharges::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # No extra charge NO_EXTRA_CHARGE = @@ -4576,14 +4452,7 @@ module Increase T.type_alias do T.all(Symbol, Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::CarRental::NoShowIndicator) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::CarRental::NoShowIndicator::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # Not applicable NOT_APPLICABLE = @@ -4776,14 +4645,7 @@ module Increase T.type_alias do T.all(Symbol, Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::Lodging::ExtraCharges) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::Lodging::ExtraCharges::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # No extra charge NO_EXTRA_CHARGE = @@ -4854,14 +4716,7 @@ module Increase T.type_alias do T.all(Symbol, Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::Lodging::NoShowIndicator) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::Lodging::NoShowIndicator::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # Not applicable NOT_APPLICABLE = @@ -4897,14 +4752,7 @@ module Increase T.type_alias do T.all(Symbol, Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::PurchaseIdentifierFormat) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::PurchaseIdentifierFormat::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # Free text FREE_TEXT = @@ -5203,14 +5051,7 @@ module Increase T.type_alias do T.all(Symbol, Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::Travel::Ancillary::CreditReasonIndicator) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::Travel::Ancillary::CreditReasonIndicator::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # No credit NO_CREDIT = @@ -5298,14 +5139,7 @@ module Increase T.type_alias do T.all(Symbol, Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::Travel::Ancillary::Service::Category) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::Travel::Ancillary::Service::Category::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # None NONE = @@ -5496,14 +5330,7 @@ module Increase T.type_alias do T.all(Symbol, Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::Travel::CreditReasonIndicator) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::Travel::CreditReasonIndicator::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # No credit NO_CREDIT = @@ -5566,14 +5393,7 @@ module Increase T.type_alias do T.all(Symbol, Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::Travel::RestrictedTicketIndicator) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::Travel::RestrictedTicketIndicator::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # No restrictions NO_RESTRICTIONS = @@ -5608,14 +5428,7 @@ module Increase T.type_alias do T.all(Symbol, Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::Travel::TicketChangeIndicator) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::Travel::TicketChangeIndicator::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # None NONE = @@ -5726,14 +5539,7 @@ module Increase T.type_alias do T.all(Symbol, Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::Travel::TripLeg::StopOverCode) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::Travel::TripLeg::StopOverCode::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # None NONE = @@ -5777,8 +5583,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::Transaction::Source::CardSettlement::Type) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::Transaction::Source::CardSettlement::Type::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } CARD_SETTLEMENT = T.let(:card_settlement, Increase::Models::Transaction::Source::CardSettlement::Type::TaggedSymbol) @@ -5848,8 +5653,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::Transaction::Source::CashbackPayment::Currency) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::Transaction::Source::CashbackPayment::Currency::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # Canadian Dollar (CAD) CAD = T.let(:CAD, Increase::Models::Transaction::Source::CashbackPayment::Currency::TaggedSymbol) @@ -5880,8 +5684,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::Transaction::Source::Category) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::Transaction::Source::Category::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # Account Transfer Intention: details will be under the `account_transfer_intention` object. ACCOUNT_TRANSFER_INTENTION = @@ -6096,14 +5899,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::Transaction::Source::CheckDepositAcceptance::Currency) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::Transaction::Source::CheckDepositAcceptance::Currency::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # Canadian Dollar (CAD) CAD = T.let(:CAD, Increase::Models::Transaction::Source::CheckDepositAcceptance::Currency::TaggedSymbol) @@ -6202,8 +5998,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::Transaction::Source::CheckDepositReturn::Currency) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::Transaction::Source::CheckDepositReturn::Currency::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # Canadian Dollar (CAD) CAD = T.let(:CAD, Increase::Models::Transaction::Source::CheckDepositReturn::Currency::TaggedSymbol) @@ -6237,14 +6032,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::Transaction::Source::CheckDepositReturn::ReturnReason) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::Transaction::Source::CheckDepositReturn::ReturnReason::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # The check doesn't allow ACH conversion. ACH_CONVERSION_NOT_SUPPORTED = @@ -6517,8 +6305,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::Transaction::Source::CheckTransferDeposit::Type) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::Transaction::Source::CheckTransferDeposit::Type::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } CHECK_TRANSFER_DEPOSIT = T.let( @@ -6586,8 +6373,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::Transaction::Source::FeePayment::Currency) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::Transaction::Source::FeePayment::Currency::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # Canadian Dollar (CAD) CAD = T.let(:CAD, Increase::Models::Transaction::Source::FeePayment::Currency::TaggedSymbol) @@ -6782,14 +6568,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::Transaction::Source::InboundACHTransfer::Addenda::Category) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::Transaction::Source::InboundACHTransfer::Addenda::Category::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # Unstructured addendum. FREEFORM = @@ -6911,8 +6690,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::Transaction::Source::InboundCheckAdjustment::Reason) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::Transaction::Source::InboundCheckAdjustment::Reason::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # The return was initiated too late and the receiving institution has responded with a Late Return Claim. LATE_RETURN = @@ -7070,14 +6848,7 @@ module Increase T.type_alias do T.all(Symbol, Increase::Models::Transaction::Source::InboundRealTimePaymentsTransferConfirmation::Currency) end - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::Transaction::Source::InboundRealTimePaymentsTransferConfirmation::Currency::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # Canadian Dollar (CAD) CAD = @@ -7240,14 +7011,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::Transaction::Source::InboundRealTimePaymentsTransferDecline::Currency) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::Transaction::Source::InboundRealTimePaymentsTransferDecline::Currency::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # Canadian Dollar (CAD) CAD = @@ -7306,14 +7070,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::Transaction::Source::InboundRealTimePaymentsTransferDecline::Reason) } - OrSymbol = - T.type_alias do - T.any( - Symbol, - String, - Increase::Models::Transaction::Source::InboundRealTimePaymentsTransferDecline::Reason::TaggedSymbol - ) - end + OrSymbol = T.type_alias { T.any(Symbol, String) } # The account number is canceled. ACCOUNT_NUMBER_CANCELED = @@ -7749,8 +7506,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::Transaction::Source::InterestPayment::Currency) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::Transaction::Source::InterestPayment::Currency::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # Canadian Dollar (CAD) CAD = T.let(:CAD, Increase::Models::Transaction::Source::InterestPayment::Currency::TaggedSymbol) @@ -7823,8 +7579,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::Transaction::Source::InternalSource::Currency) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::Transaction::Source::InternalSource::Currency::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # Canadian Dollar (CAD) CAD = T.let(:CAD, Increase::Models::Transaction::Source::InternalSource::Currency::TaggedSymbol) @@ -7855,8 +7610,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::Transaction::Source::InternalSource::Reason) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::Transaction::Source::InternalSource::Reason::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # Account closure ACCOUNT_CLOSURE = @@ -8059,7 +7813,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::Transaction::Type) } - OrSymbol = T.type_alias { T.any(Symbol, String, Increase::Models::Transaction::Type::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } TRANSACTION = T.let(:transaction, Increase::Models::Transaction::Type::TaggedSymbol) diff --git a/rbi/lib/increase/models/transaction_list_params.rbi b/rbi/lib/increase/models/transaction_list_params.rbi index 752cfd0f8..8adfb946f 100644 --- a/rbi/lib/increase/models/transaction_list_params.rbi +++ b/rbi/lib/increase/models/transaction_list_params.rbi @@ -113,8 +113,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::TransactionListParams::Category::In) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::TransactionListParams::Category::In::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # Account Transfer Intention: details will be under the `account_transfer_intention` object. ACCOUNT_TRANSFER_INTENTION = diff --git a/rbi/lib/increase/models/wire_drawdown_request.rbi b/rbi/lib/increase/models/wire_drawdown_request.rbi index 8fee59887..76c892a3b 100644 --- a/rbi/lib/increase/models/wire_drawdown_request.rbi +++ b/rbi/lib/increase/models/wire_drawdown_request.rbi @@ -190,8 +190,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::WireDrawdownRequest::Status) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::WireDrawdownRequest::Status::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # The drawdown request is queued to be submitted to Fedwire. PENDING_SUBMISSION = @@ -231,8 +230,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::WireDrawdownRequest::Type) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::WireDrawdownRequest::Type::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } WIRE_DRAWDOWN_REQUEST = T.let(:wire_drawdown_request, Increase::Models::WireDrawdownRequest::Type::TaggedSymbol) diff --git a/rbi/lib/increase/models/wire_drawdown_request_list_params.rbi b/rbi/lib/increase/models/wire_drawdown_request_list_params.rbi index 5e9e99547..85e91dcb6 100644 --- a/rbi/lib/increase/models/wire_drawdown_request_list_params.rbi +++ b/rbi/lib/increase/models/wire_drawdown_request_list_params.rbi @@ -92,8 +92,7 @@ module Increase TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::WireDrawdownRequestListParams::Status::In) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::WireDrawdownRequestListParams::Status::In::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # The drawdown request is queued to be submitted to Fedwire. PENDING_SUBMISSION = diff --git a/rbi/lib/increase/models/wire_transfer.rbi b/rbi/lib/increase/models/wire_transfer.rbi index 47df78708..6aa81e3e1 100644 --- a/rbi/lib/increase/models/wire_transfer.rbi +++ b/rbi/lib/increase/models/wire_transfer.rbi @@ -395,8 +395,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::WireTransfer::CreatedBy::Category) } - OrSymbol = - T.type_alias { T.any(Symbol, String, Increase::Models::WireTransfer::CreatedBy::Category::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # An API key. Details will be under the `api_key` object. API_KEY = T.let(:api_key, Increase::Models::WireTransfer::CreatedBy::Category::TaggedSymbol) @@ -445,7 +444,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::WireTransfer::Currency) } - OrSymbol = T.type_alias { T.any(Symbol, String, Increase::Models::WireTransfer::Currency::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # Canadian Dollar (CAD) CAD = T.let(:CAD, Increase::Models::WireTransfer::Currency::TaggedSymbol) @@ -474,7 +473,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::WireTransfer::Network) } - OrSymbol = T.type_alias { T.any(Symbol, String, Increase::Models::WireTransfer::Network::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } WIRE = T.let(:wire, Increase::Models::WireTransfer::Network::TaggedSymbol) @@ -630,7 +629,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::WireTransfer::Status) } - OrSymbol = T.type_alias { T.any(Symbol, String, Increase::Models::WireTransfer::Status::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } # The transfer is pending approval. PENDING_APPROVAL = T.let(:pending_approval, Increase::Models::WireTransfer::Status::TaggedSymbol) @@ -689,7 +688,7 @@ module Increase extend Increase::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Models::WireTransfer::Type) } - OrSymbol = T.type_alias { T.any(Symbol, String, Increase::Models::WireTransfer::Type::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String) } WIRE_TRANSFER = T.let(:wire_transfer, Increase::Models::WireTransfer::Type::TaggedSymbol) diff --git a/scripts/bootstrap b/scripts/bootstrap index 88566757f..cc31aa851 100755 --- a/scripts/bootstrap +++ b/scripts/bootstrap @@ -2,7 +2,7 @@ set -e -cd "$(dirname "$0")/.." +cd -- "$(dirname -- "$0")/.." if [ -f "Brewfile" ] && [ "$(uname -s)" = "Darwin" ] && [ "$SKIP_BREW" != "1" ]; then brew bundle check >/dev/null 2>&1 || { @@ -13,4 +13,4 @@ fi echo "==> Installing Ruby dependencies…" -bundle install +exec -- bundle install "$@" diff --git a/scripts/format b/scripts/format index 67b400de8..177d1e635 100755 --- a/scripts/format +++ b/scripts/format @@ -5,4 +5,5 @@ set -e cd -- "$(dirname -- "$0")/.." echo "==> Running formatters" + exec -- bundle exec rake format "$@" diff --git a/scripts/lint b/scripts/lint index 39581dc1d..08b0dbeb6 100755 --- a/scripts/lint +++ b/scripts/lint @@ -4,4 +4,6 @@ set -e cd -- "$(dirname -- "$0")/.." +echo "==> Running linters" + exec -- bundle exec rake lint "$@" diff --git a/scripts/test b/scripts/test index 2e1fe093c..8e5d35cdf 100755 --- a/scripts/test +++ b/scripts/test @@ -2,7 +2,7 @@ set -e -cd "$(dirname "$0")/.." +cd -- "$(dirname -- "$0")/.." RED='\033[0;31m' GREEN='\033[0;32m' diff --git a/sig/increase/internal/type/array_of.rbs b/sig/increase/internal/type/array_of.rbs index 74338ff85..7e41c01f1 100644 --- a/sig/increase/internal/type/array_of.rbs +++ b/sig/increase/internal/type/array_of.rbs @@ -15,6 +15,8 @@ module Increase def ==: (top other) -> bool + def hash: -> Integer + def coerce: ( ::Array[top] | top value, state: Increase::Internal::Type::Converter::coerce_state diff --git a/sig/increase/internal/type/base_model.rbs b/sig/increase/internal/type/base_model.rbs index a72dd5a1b..ba45d394b 100644 --- a/sig/increase/internal/type/base_model.rbs +++ b/sig/increase/internal/type/base_model.rbs @@ -49,8 +49,12 @@ module Increase def self.==: (top other) -> bool + def self.hash: -> Integer + def ==: (top other) -> bool + def hash: -> Integer + def self.coerce: ( Increase::Internal::Type::BaseModel | ::Hash[top, top] | top value, state: Increase::Internal::Type::Converter::coerce_state @@ -69,6 +73,10 @@ module Increase def deconstruct_keys: (::Array[Symbol]? keys) -> ::Hash[Symbol, top] + def self.walk: ( + Increase::Internal::Type::BaseModel model + ) -> ::Hash[Symbol, top] + def to_json: (*top a) -> String def to_yaml: (*top a) -> String @@ -77,6 +85,8 @@ module Increase def self.inspect: (?depth: Integer) -> String + def to_s: -> String + def inspect: -> String end end diff --git a/sig/increase/internal/type/enum.rbs b/sig/increase/internal/type/enum.rbs index 3e1bfafd1..6dbd0cd36 100644 --- a/sig/increase/internal/type/enum.rbs +++ b/sig/increase/internal/type/enum.rbs @@ -6,12 +6,12 @@ module Increase def self.values: -> ::Array[(nil | bool | Integer | Float | Symbol)] - private def self.finalize!: -> void - def ===: (top other) -> bool def ==: (top other) -> bool + def hash: -> Integer + def coerce: ( String | Symbol | top value, state: Increase::Internal::Type::Converter::coerce_state diff --git a/sig/increase/internal/type/hash_of.rbs b/sig/increase/internal/type/hash_of.rbs index 50221ea0c..870585e14 100644 --- a/sig/increase/internal/type/hash_of.rbs +++ b/sig/increase/internal/type/hash_of.rbs @@ -15,6 +15,8 @@ module Increase def ==: (top other) -> bool + def hash: -> Integer + def coerce: ( ::Hash[top, top] | top value, state: Increase::Internal::Type::Converter::coerce_state diff --git a/sig/increase/internal/type/union.rbs b/sig/increase/internal/type/union.rbs index 2b07fec48..ce537ae83 100644 --- a/sig/increase/internal/type/union.rbs +++ b/sig/increase/internal/type/union.rbs @@ -30,6 +30,8 @@ module Increase def ==: (top other) -> bool + def hash: -> Integer + def coerce: ( top value, state: Increase::Internal::Type::Converter::coerce_state diff --git a/sig/increase/internal/util.rbs b/sig/increase/internal/util.rbs index 37c74f2e1..4b13b048b 100644 --- a/sig/increase/internal/util.rbs +++ b/sig/increase/internal/util.rbs @@ -120,6 +120,8 @@ module Increase top body ) -> top + def self?.force_charset!: (String content_type, text: String) -> void + def self?.decode_content: ( ::Hash[String, String] headers, stream: Enumerable[String], diff --git a/sig/increase/models/card_payment.rbs b/sig/increase/models/card_payment.rbs index dab35fa27..fc95897f5 100644 --- a/sig/increase/models/card_payment.rbs +++ b/sig/increase/models/card_payment.rbs @@ -1455,6 +1455,7 @@ module Increase | :declined_by_stand_in_processing | :invalid_physical_card | :missing_original_authorization + | :failed_3ds_authentication | :suspected_fraud module Reason @@ -1508,6 +1509,9 @@ module Increase # The original card authorization for this incremental authorization does not exist. MISSING_ORIGINAL_AUTHORIZATION: :missing_original_authorization + # The transaction was declined because the 3DS authentication failed. + FAILED_3DS_AUTHENTICATION: :failed_3ds_authentication + # The transaction was suspected to be fraudulent. Please reach out to support@increase.com for more information. SUSPECTED_FRAUD: :suspected_fraud diff --git a/sig/increase/models/declined_transaction.rbs b/sig/increase/models/declined_transaction.rbs index 142d4acfc..43c496b6c 100644 --- a/sig/increase/models/declined_transaction.rbs +++ b/sig/increase/models/declined_transaction.rbs @@ -736,6 +736,7 @@ module Increase | :declined_by_stand_in_processing | :invalid_physical_card | :missing_original_authorization + | :failed_3ds_authentication | :suspected_fraud module Reason @@ -789,6 +790,9 @@ module Increase # The original card authorization for this incremental authorization does not exist. MISSING_ORIGINAL_AUTHORIZATION: :missing_original_authorization + # The transaction was declined because the 3DS authentication failed. + FAILED_3DS_AUTHENTICATION: :failed_3ds_authentication + # The transaction was suspected to be fraudulent. Please reach out to support@increase.com for more information. SUSPECTED_FRAUD: :suspected_fraud diff --git a/sig/increase/models/entity_create_params.rbs b/sig/increase/models/entity_create_params.rbs index e298beb6e..c1d6237d2 100644 --- a/sig/increase/models/entity_create_params.rbs +++ b/sig/increase/models/entity_create_params.rbs @@ -111,6 +111,7 @@ module Increase beneficial_owners: ::Array[Increase::Models::EntityCreateParams::Corporation::BeneficialOwner], name: String, tax_identifier: String, + beneficial_ownership_exemption_reason: Increase::Models::EntityCreateParams::Corporation::beneficial_ownership_exemption_reason, incorporation_state: String, industry_code: String, website: String @@ -125,6 +126,12 @@ module Increase attr_accessor tax_identifier: String + attr_reader beneficial_ownership_exemption_reason: Increase::Models::EntityCreateParams::Corporation::beneficial_ownership_exemption_reason? + + def beneficial_ownership_exemption_reason=: ( + Increase::Models::EntityCreateParams::Corporation::beneficial_ownership_exemption_reason + ) -> Increase::Models::EntityCreateParams::Corporation::beneficial_ownership_exemption_reason + attr_reader incorporation_state: String? def incorporation_state=: (String) -> String @@ -142,6 +149,7 @@ module Increase beneficial_owners: ::Array[Increase::Models::EntityCreateParams::Corporation::BeneficialOwner], name: String, tax_identifier: String, + ?beneficial_ownership_exemption_reason: Increase::Models::EntityCreateParams::Corporation::beneficial_ownership_exemption_reason, ?incorporation_state: String, ?industry_code: String, ?website: String @@ -450,6 +458,26 @@ module Increase def self?.values: -> ::Array[Increase::Models::EntityCreateParams::Corporation::BeneficialOwner::prong] end end + + type beneficial_ownership_exemption_reason = + :regulated_financial_institution + | :publicly_traded_company + | :public_entity + + module BeneficialOwnershipExemptionReason + extend Increase::Internal::Type::Enum + + # A regulated financial institution. + REGULATED_FINANCIAL_INSTITUTION: :regulated_financial_institution + + # A publicly traded company. + PUBLICLY_TRADED_COMPANY: :publicly_traded_company + + # A public entity acting on behalf of the federal or a state government. + PUBLIC_ENTITY: :public_entity + + def self?.values: -> ::Array[Increase::Models::EntityCreateParams::Corporation::beneficial_ownership_exemption_reason] + end end type government_authority = diff --git a/sig/increase/models/inbound_wire_drawdown_request.rbs b/sig/increase/models/inbound_wire_drawdown_request.rbs index 57ffa1a1e..b4f799030 100644 --- a/sig/increase/models/inbound_wire_drawdown_request.rbs +++ b/sig/increase/models/inbound_wire_drawdown_request.rbs @@ -13,7 +13,7 @@ module Increase created_at: Time, currency: String, message_to_recipient: String?, - originator_account_number: String, + originator_account_number: String?, :originator_address_line1 => String?, :originator_address_line2 => String?, :originator_address_line3 => String?, @@ -50,7 +50,7 @@ module Increase attr_accessor message_to_recipient: String? - attr_accessor originator_account_number: String + attr_accessor originator_account_number: String? attr_accessor originator_address_line1: String? @@ -86,7 +86,7 @@ module Increase created_at: Time, currency: String, message_to_recipient: String?, - originator_account_number: String, + originator_account_number: String?, originator_address_line1: String?, originator_address_line2: String?, originator_address_line3: String?, diff --git a/sig/increase/models/proof_of_authorization_request_submission.rbs b/sig/increase/models/proof_of_authorization_request_submission.rbs index afcf7e82d..9edb67929 100644 --- a/sig/increase/models/proof_of_authorization_request_submission.rbs +++ b/sig/increase/models/proof_of_authorization_request_submission.rbs @@ -3,7 +3,7 @@ module Increase type proof_of_authorization_request_submission = { id: String, - additional_evidence_file_id: String?, + additional_evidence_files: ::Array[Increase::Models::ProofOfAuthorizationRequestSubmission::AdditionalEvidenceFile], authorization_terms: String, authorized_at: Time, authorizer_company: String?, @@ -25,7 +25,7 @@ module Increase class ProofOfAuthorizationRequestSubmission < Increase::Internal::Type::BaseModel attr_accessor id: String - attr_accessor additional_evidence_file_id: String? + attr_accessor additional_evidence_files: ::Array[Increase::Models::ProofOfAuthorizationRequestSubmission::AdditionalEvidenceFile] attr_accessor authorization_terms: String @@ -61,7 +61,7 @@ module Increase def initialize: ( id: String, - additional_evidence_file_id: String?, + additional_evidence_files: ::Array[Increase::Models::ProofOfAuthorizationRequestSubmission::AdditionalEvidenceFile], authorization_terms: String, authorized_at: Time, authorizer_company: String?, @@ -82,6 +82,16 @@ module Increase def to_hash: -> Increase::Models::proof_of_authorization_request_submission + type additional_evidence_file = { file_id: String } + + class AdditionalEvidenceFile < Increase::Internal::Type::BaseModel + attr_accessor file_id: String + + def initialize: (file_id: String) -> void + + def to_hash: -> Increase::Models::ProofOfAuthorizationRequestSubmission::additional_evidence_file + end + type status = :pending_review | :rejected | :canceled | :pending_sending | :sent diff --git a/sig/increase/models/simulations/card_authorization_create_params.rbs b/sig/increase/models/simulations/card_authorization_create_params.rbs index 99b4aea56..66b4c3f33 100644 --- a/sig/increase/models/simulations/card_authorization_create_params.rbs +++ b/sig/increase/models/simulations/card_authorization_create_params.rbs @@ -139,6 +139,7 @@ module Increase | :declined_by_stand_in_processing | :invalid_physical_card | :missing_original_authorization + | :failed_3ds_authentication | :suspected_fraud module DeclineReason @@ -192,6 +193,9 @@ module Increase # The original card authorization for this incremental authorization does not exist. MISSING_ORIGINAL_AUTHORIZATION: :missing_original_authorization + # The transaction was declined because the 3DS authentication failed. + FAILED_3DS_AUTHENTICATION: :failed_3ds_authentication + # The transaction was suspected to be fraudulent. Please reach out to support@increase.com for more information. SUSPECTED_FRAUD: :suspected_fraud diff --git a/sorbet/rbi/.gitignore b/sorbet/rbi/.gitignore new file mode 100644 index 000000000..d6b7ef32c --- /dev/null +++ b/sorbet/rbi/.gitignore @@ -0,0 +1,2 @@ +* +!.gitignore diff --git a/test/increase/client_test.rb b/test/increase/client_test.rb index 8124c7aa5..566c2871e 100644 --- a/test/increase/client_test.rb +++ b/test/increase/client_test.rb @@ -11,16 +11,6 @@ def teardown Thread.current.thread_variable_set(:mock_sleep, nil) end - def test_raises_on_both_base_url_and_environment - e = assert_raises(ArgumentError) do - Increase::Client.new( - base_url: "https://localhost:8000", - environment: "production" - ) - end - assert_match(/both environment and base_url given/, e.message) - end - def test_raises_on_unknown_environment e = assert_raises(ArgumentError) do Increase::Client.new(environment: "wrong") diff --git a/test/increase/internal/type/base_model_test.rb b/test/increase/internal/type/base_model_test.rb index 4cf104bfd..1dcc64101 100644 --- a/test/increase/internal/type/base_model_test.rb +++ b/test/increase/internal/type/base_model_test.rb @@ -156,6 +156,7 @@ def test_dump_retry class Increase::Test::EnumModelTest < Minitest::Test class E0 include Increase::Internal::Type::Enum + attr_reader :values def initialize(*values) = (@values = values) end @@ -575,6 +576,7 @@ def test_coerce class Increase::Test::BaseModelQoLTest < Minitest::Test class E0 include Increase::Internal::Type::Enum + attr_reader :values def initialize(*values) = (@values = values) end @@ -645,14 +647,17 @@ def test_equality [U0.new(String, Float), U0.new(String, Integer)] => false, [U1, U2] => true, [M1, M2] => false, - [M1, M3] => true + [M1, M3] => true, + [M1.new(a: 1), M1.new(a: 1)] => true } cases.each do if _2 assert_equal(*_1) + assert_equal(*_1.map(&:hash)) else refute_equal(*_1) + refute_equal(*_1.map(&:hash)) end end end diff --git a/test/increase/internal/util_test.rb b/test/increase/internal/util_test.rb index fe64cc22f..4a671c043 100644 --- a/test/increase/internal/util_test.rb +++ b/test/increase/internal/util_test.rb @@ -368,6 +368,24 @@ def test_close_fused_sse_chain end end +class Increase::Test::UtilContentDecodingTest < Minitest::Test + def test_charset + cases = { + "application/json" => Encoding::BINARY, + "application/json; charset=utf-8" => Encoding::UTF_8, + "charset=uTf-8 application/json; " => Encoding::UTF_8, + "charset=UTF-8; application/json; " => Encoding::UTF_8, + "charset=ISO-8859-1 ;application/json; " => Encoding::ISO_8859_1, + "charset=EUC-KR ;application/json; " => Encoding::EUC_KR + } + text = String.new.force_encoding(Encoding::BINARY) + cases.each do |content_type, encoding| + Increase::Internal::Util.force_charset!(content_type, text: text) + assert_equal(encoding, text.encoding) + end + end +end + class Increase::Test::UtilSseTest < Minitest::Test def test_decode_lines cases = { @@ -381,7 +399,9 @@ def test_decode_lines %W[\na b\n\n] => %W[\n ab\n \n], %W[\na b] => %W[\n ab], %W[\u1F62E\u200D\u1F4A8] => %W[\u1F62E\u200D\u1F4A8], - %W[\u1F62E \u200D \u1F4A8] => %W[\u1F62E\u200D\u1F4A8] + %W[\u1F62E \u200D \u1F4A8] => %W[\u1F62E\u200D\u1F4A8], + ["\xf0\x9f".b, "\xa5\xba".b] => ["\xf0\x9f\xa5\xba".b], + ["\xf0".b, "\x9f".b, "\xa5".b, "\xba".b] => ["\xf0\x9f\xa5\xba".b] } eols = %W[\n \r \r\n] cases.each do |enum, expected| diff --git a/test/increase/resources/inbound_wire_drawdown_requests_test.rb b/test/increase/resources/inbound_wire_drawdown_requests_test.rb index 930d0b63d..4a7a8e420 100644 --- a/test/increase/resources/inbound_wire_drawdown_requests_test.rb +++ b/test/increase/resources/inbound_wire_drawdown_requests_test.rb @@ -23,7 +23,7 @@ def test_retrieve created_at: Time, currency: String, message_to_recipient: String | nil, - originator_account_number: String, + originator_account_number: String | nil, originator_address_line1: String | nil, originator_address_line2: String | nil, originator_address_line3: String | nil, @@ -66,7 +66,7 @@ def test_list created_at: Time, currency: String, message_to_recipient: String | nil, - originator_account_number: String, + originator_account_number: String | nil, originator_address_line1: String | nil, originator_address_line2: String | nil, originator_address_line3: String | nil, diff --git a/test/increase/resources/proof_of_authorization_request_submissions_test.rb b/test/increase/resources/proof_of_authorization_request_submissions_test.rb index bb0a36fcd..dc395ec31 100644 --- a/test/increase/resources/proof_of_authorization_request_submissions_test.rb +++ b/test/increase/resources/proof_of_authorization_request_submissions_test.rb @@ -24,7 +24,7 @@ def test_create_required_params assert_pattern do response => { id: String, - additional_evidence_file_id: String | nil, + additional_evidence_files: ^(Increase::Internal::Type::ArrayOf[Increase::Models::ProofOfAuthorizationRequestSubmission::AdditionalEvidenceFile]), authorization_terms: String, authorized_at: Time, authorizer_company: String | nil, @@ -58,7 +58,7 @@ def test_retrieve assert_pattern do response => { id: String, - additional_evidence_file_id: String | nil, + additional_evidence_files: ^(Increase::Internal::Type::ArrayOf[Increase::Models::ProofOfAuthorizationRequestSubmission::AdditionalEvidenceFile]), authorization_terms: String, authorized_at: Time, authorizer_company: String | nil, @@ -96,7 +96,7 @@ def test_list assert_pattern do row => { id: String, - additional_evidence_file_id: String | nil, + additional_evidence_files: ^(Increase::Internal::Type::ArrayOf[Increase::Models::ProofOfAuthorizationRequestSubmission::AdditionalEvidenceFile]), authorization_terms: String, authorized_at: Time, authorizer_company: String | nil, diff --git a/test/increase/resources/simulations/inbound_wire_drawdown_requests_test.rb b/test/increase/resources/simulations/inbound_wire_drawdown_requests_test.rb index 8ea154d26..7f5d9eeaa 100644 --- a/test/increase/resources/simulations/inbound_wire_drawdown_requests_test.rb +++ b/test/increase/resources/simulations/inbound_wire_drawdown_requests_test.rb @@ -33,7 +33,7 @@ def test_create_required_params created_at: Time, currency: String, message_to_recipient: String | nil, - originator_account_number: String, + originator_account_number: String | nil, originator_address_line1: String | nil, originator_address_line2: String | nil, originator_address_line3: String | nil,